eventdev: remove return value comment in pmd api
Checks
Commit Message
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(-)
Comments
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.
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
>
@@ -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);