diff mbox series

eventdev: remove return value comment in pmd api

Message ID 20210201131946.133378-1-harry.van.haaren@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Jerin Jacob
Headers
Series eventdev: remove return value comment in pmd api |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-testing warning Testing issues

Commit Message

Van Haaren, Harry Feb. 1, 2021, 1:19 p.m. UTC 
  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

David Marchand Feb. 1, 2021, 1:27 p.m. UTC | #1 
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.
Jerin Jacob Feb. 4, 2021, 6:16 p.m. UTC | #2 
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
>
diff mbox series

Patch

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);