diff mbox series

[v3,3/4] mbuf: make rte_mbuf_tx_offload as stable

Message ID 20210831193507.43426-4-stephen@networkplumber.org (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series mbuf: promote experimental API's to stable |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Stephen Hemminger Aug. 31, 2021, 7:35 p.m. UTC 
  This function should be made stable now.

Also, fix the docbook comment format.

Fixes: 8d9c2c3a1f01 ("mbuf: add function to generate raw Tx offload value")
Cc: konstantin.ananyev@intel.com
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 lib/mbuf/rte_mbuf.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Andrew Rybchenko Sept. 1, 2021, 6:45 a.m. UTC | #1 
On 8/31/21 10:35 PM, Stephen Hemminger wrote:
> This function should be made stable now.
> 
> Also, fix the docbook comment format.
> 
> Fixes: 8d9c2c3a1f01 ("mbuf: add function to generate raw Tx offload value")
> Cc: konstantin.ananyev@intel.com
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>

I'm not sure that it is correct to have promotion with
Fixes tag. It will require extra care on backporting to
stable.

Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>

> ---
>  lib/mbuf/rte_mbuf.h | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/lib/mbuf/rte_mbuf.h b/lib/mbuf/rte_mbuf.h
> index 7722b36ee44b..627790fe26e7 100644
> --- a/lib/mbuf/rte_mbuf.h
> +++ b/lib/mbuf/rte_mbuf.h
> @@ -1773,7 +1773,7 @@ static inline int rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail
>  	return 0;
>  }
>  
> -/*
> +/**
>   * @warning
>   * @b EXPERIMENTAL: This API may change without prior notice.

The warning must be removed.

>   *
> @@ -1797,6 +1797,7 @@ static inline int rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail
>   * @return
>   *   raw tx_offload value.
>   */
> +__rte_experimental
>  static __rte_always_inline uint64_t
>  rte_mbuf_tx_offload(uint64_t il2, uint64_t il3, uint64_t il4, uint64_t tso,
>  	uint64_t ol3, uint64_t ol2, uint64_t unused)
>
Stephen Hemminger Sept. 1, 2021, 5:14 p.m. UTC | #2 
On Wed, 1 Sep 2021 09:45:22 +0300
Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru> wrote:

> On 8/31/21 10:35 PM, Stephen Hemminger wrote:
> > This function should be made stable now.
> > 
> > Also, fix the docbook comment format.
> > 
> > Fixes: 8d9c2c3a1f01 ("mbuf: add function to generate raw Tx offload value")
> > Cc: konstantin.ananyev@intel.com
> > Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>  
> 
> I'm not sure that it is correct to have promotion with
> Fixes tag. It will require extra care on backporting to
> stable.
> 

I would not recommend bothering with backport of docbook
only fix.
Olivier Matz Sept. 16, 2021, 12:14 p.m. UTC | #3 
On Wed, Sep 01, 2021 at 09:45:22AM +0300, Andrew Rybchenko wrote:
> On 8/31/21 10:35 PM, Stephen Hemminger wrote:
> > This function should be made stable now.
> > 
> > Also, fix the docbook comment format.
> > 
> > Fixes: 8d9c2c3a1f01 ("mbuf: add function to generate raw Tx offload value")
> > Cc: konstantin.ananyev@intel.com
> > Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> 
> I'm not sure that it is correct to have promotion with
> Fixes tag. It will require extra care on backporting to
> stable.
> 
> Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
> 
> > ---
> >  lib/mbuf/rte_mbuf.h | 3 ++-
> >  1 file changed, 2 insertions(+), 1 deletion(-)
> > 
> > diff --git a/lib/mbuf/rte_mbuf.h b/lib/mbuf/rte_mbuf.h
> > index 7722b36ee44b..627790fe26e7 100644
> > --- a/lib/mbuf/rte_mbuf.h
> > +++ b/lib/mbuf/rte_mbuf.h
> > @@ -1773,7 +1773,7 @@ static inline int rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail
> >  	return 0;
> >  }
> >  
> > -/*
> > +/**
> >   * @warning
> >   * @b EXPERIMENTAL: This API may change without prior notice.
> 
> The warning must be removed.

Just to highligth this comment from Andrew.


> 
> >   *
> > @@ -1797,6 +1797,7 @@ static inline int rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail
> >   * @return
> >   *   raw tx_offload value.
> >   */
> > +__rte_experimental
> >  static __rte_always_inline uint64_t
> >  rte_mbuf_tx_offload(uint64_t il2, uint64_t il3, uint64_t il4, uint64_t tso,
> >  	uint64_t ol3, uint64_t ol2, uint64_t unused)
> > 
>
David Marchand Oct. 2, 2021, 9:34 a.m. UTC | #4 
On Tue, Aug 31, 2021 at 9:35 PM Stephen Hemminger
<stephen@networkplumber.org> wrote:
>
> This function should be made stable now.
>
> Also, fix the docbook comment format.
>
> Fixes: 8d9c2c3a1f01 ("mbuf: add function to generate raw Tx offload value")
> Cc: konstantin.ananyev@intel.com
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> ---
>  lib/mbuf/rte_mbuf.h | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/lib/mbuf/rte_mbuf.h b/lib/mbuf/rte_mbuf.h
> index 7722b36ee44b..627790fe26e7 100644
> --- a/lib/mbuf/rte_mbuf.h
> +++ b/lib/mbuf/rte_mbuf.h
> @@ -1773,7 +1773,7 @@ static inline int rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail
>         return 0;
>  }
>
> -/*
> +/**
>   * @warning
>   * @b EXPERIMENTAL: This API may change without prior notice.
>   *
> @@ -1797,6 +1797,7 @@ static inline int rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail
>   * @return
>   *   raw tx_offload value.
>   */
> +__rte_experimental

From title and description, I would expect we remove
__rte_experimental tag, not add one.
Can you clarify the intention?


>  static __rte_always_inline uint64_t
>  rte_mbuf_tx_offload(uint64_t il2, uint64_t il3, uint64_t il4, uint64_t tso,
>         uint64_t ol3, uint64_t ol2, uint64_t unused)
> --
> 2.30.2
>
diff mbox series

Patch

diff --git a/lib/mbuf/rte_mbuf.h b/lib/mbuf/rte_mbuf.h
index 7722b36ee44b..627790fe26e7 100644
--- a/lib/mbuf/rte_mbuf.h
+++ b/lib/mbuf/rte_mbuf.h
@@ -1773,7 +1773,7 @@  static inline int rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail
 	return 0;
 }
 
-/*
+/**
  * @warning
  * @b EXPERIMENTAL: This API may change without prior notice.
  *
@@ -1797,6 +1797,7 @@  static inline int rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail
  * @return
  *   raw tx_offload value.
  */
+__rte_experimental
 static __rte_always_inline uint64_t
 rte_mbuf_tx_offload(uint64_t il2, uint64_t il3, uint64_t il4, uint64_t tso,
 	uint64_t ol3, uint64_t ol2, uint64_t unused)