From: David Marchand <david.marchand@redhat.com>
To: Gage Eads <gage.eads@intel.com>
Cc: dev <dev@dpdk.org>, Thomas Monjalon <thomas@monjalon.net>,
Ray Kinsella <mdr@ashroe.eu>,
Neil Horman <nhorman@tuxdriver.com>,
Phil Yang <phil.yang@arm.com>,
Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Subject: Re: [dpdk-dev] [20.11] [PATCH v2] stack: remove experimental tag from API
Date: Wed, 30 Sep 2020 20:49:30 +0200 [thread overview]
Message-ID: <CAJFAV8yWJHTJCaxH77MMuwyEc0RbeXUsmGxAdLcjkmLP847skg@mail.gmail.com> (raw)
In-Reply-To: <20200528150442.321-1-gage.eads@intel.com>
On Thu, May 28, 2020 at 5:06 PM Gage Eads <gage.eads@intel.com> wrote:
>
> The stack library was first released in 19.05, and its interfaces have been
> stable since their initial introduction. This commit promotes the full
> interface to stable, starting with the 20.11 major version.
>
> Signed-off-by: Gage Eads <gage.eads@intel.com>
> ---
> doc/guides/rel_notes/release_20_11.rst | 3 +++
> lib/librte_stack/rte_stack.h | 29 -----------------------------
> lib/librte_stack/rte_stack_lf.h | 2 --
> lib/librte_stack/rte_stack_std.h | 3 ---
> lib/librte_stack/rte_stack_version.map | 2 +-
> 5 files changed, 4 insertions(+), 35 deletions(-)
>
> v2:
> - Added 20.11 tag, will set patch status to 'Deferred' so it is skipped
> for the 20.08 development period.
> - Added release notes announcement. release_20_11.rst doesn't exist yet,
> so I made the change to release_20_08.rst then edited the filename
> directly in the patch. This will not apply cleanly.
> - Changed rte_stack_version.map version to DPDK_21.
>
> diff --git a/doc/guides/rel_notes/release_20_11.rst b/doc/guides/rel_notes/release_20_11.rst
> index 39064afbe..4eaf4f17d 100644
> --- a/doc/guides/rel_notes/release_20_11.rst
> +++ b/doc/guides/rel_notes/release_20_11.rst
> @@ -101,6 +101,9 @@ ABI Changes
> Also, make sure to start the actual text at the margin.
> =========================================================
>
> +* stack: the experimental tag has been dropped from the stack library, and its
> + interfaces are considered stable as of DPDK 20.11.
> +
I would move this to the API changes section, as proposed by Thomas before.
> * No ABI change that would break compatibility with 19.11.
>
>
> diff --git a/lib/librte_stack/rte_stack.h b/lib/librte_stack/rte_stack.h
> index 27ddb199e..343dd019a 100644
> --- a/lib/librte_stack/rte_stack.h
> +++ b/lib/librte_stack/rte_stack.h
> @@ -4,7 +4,6 @@
>
> /**
> * @file rte_stack.h
> - * @b EXPERIMENTAL: this API may change without prior notice
There is a little conflict here that git-pw/git-am seems to silently skip...
> *
> * RTE Stack
> *
> @@ -98,9 +97,6 @@ struct rte_stack {
> #include "rte_stack_lf.h"
>
> /**
> - * @warning
> - * @b EXPERIMENTAL: this API may change without prior notice
> - *
> * Push several objects on the stack (MT-safe).
> *
> * @param s
> @@ -112,7 +108,6 @@ struct rte_stack {
> * @return
> * Actual number of objects pushed (either 0 or *n*).
> */
> -__rte_experimental
> static __rte_always_inline unsigned int
> rte_stack_push(struct rte_stack *s, void * const *obj_table, unsigned int n)
> {
> @@ -126,9 +121,6 @@ rte_stack_push(struct rte_stack *s, void * const *obj_table, unsigned int n)
> }
>
> /**
> - * @warning
> - * @b EXPERIMENTAL: this API may change without prior notice
> - *
> * Pop several objects from the stack (MT-safe).
> *
> * @param s
> @@ -140,7 +132,6 @@ rte_stack_push(struct rte_stack *s, void * const *obj_table, unsigned int n)
> * @return
> * Actual number of objects popped (either 0 or *n*).
> */
> -__rte_experimental
> static __rte_always_inline unsigned int
> rte_stack_pop(struct rte_stack *s, void **obj_table, unsigned int n)
> {
> @@ -154,9 +145,6 @@ rte_stack_pop(struct rte_stack *s, void **obj_table, unsigned int n)
> }
>
> /**
> - * @warning
> - * @b EXPERIMENTAL: this API may change without prior notice
> - *
> * Return the number of used entries in a stack.
> *
> * @param s
> @@ -164,7 +152,6 @@ rte_stack_pop(struct rte_stack *s, void **obj_table, unsigned int n)
> * @return
> * The number of used entries in the stack.
> */
> -__rte_experimental
> static __rte_always_inline unsigned int
> rte_stack_count(struct rte_stack *s)
> {
> @@ -177,9 +164,6 @@ rte_stack_count(struct rte_stack *s)
> }
>
> /**
> - * @warning
> - * @b EXPERIMENTAL: this API may change without prior notice
> - *
> * Return the number of free entries in a stack.
> *
> * @param s
> @@ -187,7 +171,6 @@ rte_stack_count(struct rte_stack *s)
> * @return
> * The number of free entries in the stack.
> */
> -__rte_experimental
> static __rte_always_inline unsigned int
> rte_stack_free_count(struct rte_stack *s)
> {
> @@ -197,9 +180,6 @@ rte_stack_free_count(struct rte_stack *s)
> }
>
> /**
> - * @warning
> - * @b EXPERIMENTAL: this API may change without prior notice
> - *
> * Create a new stack named *name* in memory.
> *
> * This function uses ``memzone_reserve()`` to allocate memory for a stack of
> @@ -226,28 +206,20 @@ rte_stack_free_count(struct rte_stack *s)
> * - ENOMEM - insufficient memory to create the stack
> * - ENAMETOOLONG - name size exceeds RTE_STACK_NAMESIZE
> */
> -__rte_experimental
> struct rte_stack *
> rte_stack_create(const char *name, unsigned int count, int socket_id,
> uint32_t flags);
>
> /**
> - * @warning
> - * @b EXPERIMENTAL: this API may change without prior notice
> - *
> * Free all memory used by the stack.
> *
> * @param s
> * Stack to free
> */
> -__rte_experimental
> void
> rte_stack_free(struct rte_stack *s);
>
> /**
> - * @warning
> - * @b EXPERIMENTAL: this API may change without prior notice
> - *
> * Lookup a stack by its name.
> *
> * @param name
> @@ -258,7 +230,6 @@ rte_stack_free(struct rte_stack *s);
> * - ENOENT - Stack with name *name* not found.
> * - EINVAL - *name* pointer is NULL.
> */
> -__rte_experimental
> struct rte_stack *
> rte_stack_lookup(const char *name);
>
> diff --git a/lib/librte_stack/rte_stack_lf.h b/lib/librte_stack/rte_stack_lf.h
> index e67630c27..eb106e64e 100644
> --- a/lib/librte_stack/rte_stack_lf.h
> +++ b/lib/librte_stack/rte_stack_lf.h
> @@ -27,7 +27,6 @@
> * @return
> * Actual number of objects enqueued.
> */
> -__rte_experimental
> static __rte_always_inline unsigned int
> __rte_stack_lf_push(struct rte_stack *s,
> void * const *obj_table,
> @@ -66,7 +65,6 @@ __rte_stack_lf_push(struct rte_stack *s,
> * @return
> * - Actual number of objects popped.
> */
> -__rte_experimental
> static __rte_always_inline unsigned int
> __rte_stack_lf_pop(struct rte_stack *s, void **obj_table, unsigned int n)
> {
> diff --git a/lib/librte_stack/rte_stack_std.h b/lib/librte_stack/rte_stack_std.h
> index 7142cbf8e..ae28add5c 100644
> --- a/lib/librte_stack/rte_stack_std.h
> +++ b/lib/librte_stack/rte_stack_std.h
> @@ -19,7 +19,6 @@
> * @return
> * Actual number of objects pushed (either 0 or *n*).
> */
> -__rte_experimental
> static __rte_always_inline unsigned int
> __rte_stack_std_push(struct rte_stack *s, void * const *obj_table,
> unsigned int n)
> @@ -59,7 +58,6 @@ __rte_stack_std_push(struct rte_stack *s, void * const *obj_table,
> * @return
> * Actual number of objects popped (either 0 or *n*).
> */
> -__rte_experimental
> static __rte_always_inline unsigned int
> __rte_stack_std_pop(struct rte_stack *s, void **obj_table, unsigned int n)
> {
> @@ -94,7 +92,6 @@ __rte_stack_std_pop(struct rte_stack *s, void **obj_table, unsigned int n)
> * @return
> * The number of used entries in the stack.
> */
> -__rte_experimental
> static __rte_always_inline unsigned int
> __rte_stack_std_count(struct rte_stack *s)
> {
> diff --git a/lib/librte_stack/rte_stack_version.map b/lib/librte_stack/rte_stack_version.map
> index 6662679c3..8c4ca0245 100644
> --- a/lib/librte_stack/rte_stack_version.map
> +++ b/lib/librte_stack/rte_stack_version.map
> @@ -1,4 +1,4 @@
> -EXPERIMENTAL {
> +DPDK_21 {
> global:
>
> rte_stack_create;
> --
> 2.13.6
>
Otherwise, lgtm.
Acked-by: David Marchand <david.marchand@redhat.com>
--
David Marchand
next prev parent reply other threads:[~2020-09-30 18:49 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-28 1:04 [dpdk-dev] [PATCH] " Gage Eads
2020-05-28 5:46 ` Ray Kinsella
2020-05-28 8:10 ` Thomas Monjalon
2020-05-28 8:22 ` Ray Kinsella
2020-05-28 14:18 ` Eads, Gage
2020-05-28 14:33 ` Bruce Richardson
2020-05-28 15:04 ` [dpdk-dev] [20.11] [PATCH v2] " Gage Eads
2020-05-28 15:29 ` Thomas Monjalon
2020-09-30 18:49 ` David Marchand [this message]
2020-09-30 21:39 ` [dpdk-dev] [PATCH] " Gage Eads
2020-10-05 9:07 ` Kinsella, Ray
2020-10-05 9:53 ` Kinsella, Ray
2020-10-05 12:57 ` David Marchand
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CAJFAV8yWJHTJCaxH77MMuwyEc0RbeXUsmGxAdLcjkmLP847skg@mail.gmail.com \
--to=david.marchand@redhat.com \
--cc=dev@dpdk.org \
--cc=gage.eads@intel.com \
--cc=honnappa.nagarahalli@arm.com \
--cc=mdr@ashroe.eu \
--cc=nhorman@tuxdriver.com \
--cc=phil.yang@arm.com \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).