DPDK patches and discussions
 help / color / mirror / Atom feed
* [dpdk-dev] [PATCH] eventdev: remove return value comment in pmd api
@ 2021-02-01 13:19 Harry van Haaren
  2021-02-01 13:27 ` David Marchand
  0 siblings, 1 reply; 3+ messages in thread
From: Harry van Haaren @ 2021-02-01 13:19 UTC (permalink / raw)
  To: dev; +Cc: fredrik.a.lindgren, jerinj, Harry van Haaren

The PMD info get API has a void return type. Remove the
@return 0 Success doxygen comment as it doesn't make sense here.

Reported-by: Fredrik A Lindgren <fredrik.a.lindgren@tietoevry.com>
Signed-off-by: Harry van Haaren <harry.van.haaren@intel.com>
---
 lib/librte_eventdev/eventdev_pmd.h | 3 ---
 1 file changed, 3 deletions(-)

diff --git a/lib/librte_eventdev/eventdev_pmd.h b/lib/librte_eventdev/eventdev_pmd.h
index 9e83993efa..7eb9a77393 100644
--- a/lib/librte_eventdev/eventdev_pmd.h
+++ b/lib/librte_eventdev/eventdev_pmd.h
@@ -158,9 +158,6 @@ rte_event_pmd_is_valid_dev(uint8_t dev_id)
  *   Event device pointer
  * @param dev_info
  *   Event device information structure
- *
- * @return
- *   Returns 0 on success
  */
 typedef void (*eventdev_info_get_t)(struct rte_eventdev *dev,
 		struct rte_event_dev_info *dev_info);
-- 
2.25.1


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [dpdk-dev] [PATCH] eventdev: remove return value comment in pmd api
  2021-02-01 13:19 [dpdk-dev] [PATCH] eventdev: remove return value comment in pmd api Harry van Haaren
@ 2021-02-01 13:27 ` David Marchand
  2021-02-04 18:16   ` Jerin Jacob
  0 siblings, 1 reply; 3+ messages in thread
From: David Marchand @ 2021-02-01 13:27 UTC (permalink / raw)
  To: Harry van Haaren; +Cc: dev, fredrik.a.lindgren, Jerin Jacob Kollanukkaran

On Mon, Feb 1, 2021 at 2:20 PM Harry van Haaren
<harry.van.haaren@intel.com> wrote:
>
> The PMD info get API has a void return type. Remove the
> @return 0 Success doxygen comment as it doesn't make sense here.

Fixes: 5223a1f3b8de ("eventdev: define southbound driver interface")
Cc: stable@dpdk.org

>
> Reported-by: Fredrik A Lindgren <fredrik.a.lindgren@tietoevry.com>
> Signed-off-by: Harry van Haaren <harry.van.haaren@intel.com>
> ---
>  lib/librte_eventdev/eventdev_pmd.h | 3 ---
>  1 file changed, 3 deletions(-)
>
> diff --git a/lib/librte_eventdev/eventdev_pmd.h b/lib/librte_eventdev/eventdev_pmd.h
> index 9e83993efa..7eb9a77393 100644
> --- a/lib/librte_eventdev/eventdev_pmd.h
> +++ b/lib/librte_eventdev/eventdev_pmd.h
> @@ -158,9 +158,6 @@ rte_event_pmd_is_valid_dev(uint8_t dev_id)
>   *   Event device pointer
>   * @param dev_info
>   *   Event device information structure
> - *
> - * @return
> - *   Returns 0 on success
>   */
>  typedef void (*eventdev_info_get_t)(struct rte_eventdev *dev,
>                 struct rte_event_dev_info *dev_info);
> --
> 2.25.1
>

LGTM.

-- 
David Marchand


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [dpdk-dev] [PATCH] eventdev: remove return value comment in pmd api
  2021-02-01 13:27 ` David Marchand
@ 2021-02-04 18:16   ` Jerin Jacob
  0 siblings, 0 replies; 3+ messages in thread
From: Jerin Jacob @ 2021-02-04 18:16 UTC (permalink / raw)
  To: David Marchand
  Cc: Harry van Haaren, dev, fredrik.a.lindgren, Jerin Jacob Kollanukkaran

On Mon, Feb 1, 2021 at 6:57 PM David Marchand <david.marchand@redhat.com> wrote:
>
> On Mon, Feb 1, 2021 at 2:20 PM Harry van Haaren
> <harry.van.haaren@intel.com> wrote:
> >
> > The PMD info get API has a void return type. Remove the
> > @return 0 Success doxygen comment as it doesn't make sense here.
>
> Fixes: 5223a1f3b8de ("eventdev: define southbound driver interface")
> Cc: stable@dpdk.org
>
> >
> > Reported-by: Fredrik A Lindgren <fredrik.a.lindgren@tietoevry.com>
> > Signed-off-by: Harry van Haaren <harry.van.haaren@intel.com>



Reviewed-by: Jerin Jacob <jerinj@marvell.com>

Applied to dpdk-next-eventdev/for-main. Thanks.


> > ---
> >  lib/librte_eventdev/eventdev_pmd.h | 3 ---
> >  1 file changed, 3 deletions(-)
> >
> > diff --git a/lib/librte_eventdev/eventdev_pmd.h b/lib/librte_eventdev/eventdev_pmd.h
> > index 9e83993efa..7eb9a77393 100644
> > --- a/lib/librte_eventdev/eventdev_pmd.h
> > +++ b/lib/librte_eventdev/eventdev_pmd.h
> > @@ -158,9 +158,6 @@ rte_event_pmd_is_valid_dev(uint8_t dev_id)
> >   *   Event device pointer
> >   * @param dev_info
> >   *   Event device information structure
> > - *
> > - * @return
> > - *   Returns 0 on success
> >   */
> >  typedef void (*eventdev_info_get_t)(struct rte_eventdev *dev,
> >                 struct rte_event_dev_info *dev_info);
> > --
> > 2.25.1
> >
>
> LGTM.
>
> --
> David Marchand
>

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2021-02-04 18:17 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-02-01 13:19 [dpdk-dev] [PATCH] eventdev: remove return value comment in pmd api Harry van Haaren
2021-02-01 13:27 ` David Marchand
2021-02-04 18:16   ` Jerin Jacob

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).