diff mbox series

[v5,14/26] meter: remove experimental warning from comments

Message ID	20231020205759.195126-15-stephen@networkplumber.org (mailing list archive)
State	Superseded, archived
Delegated to:	Thomas Monjalon
Headers	From: Stephen Hemminger <stephen@networkplumber.org> To: dev@dpdk.org Cc: Stephen Hemminger <stephen@networkplumber.org>, Bruce Richardson <bruce.richardson@intel.com>, Cristian Dumitrescu <cristian.dumitrescu@intel.com> Subject: [PATCH v5 14/26] meter: remove experimental warning from comments Date: Fri, 20 Oct 2023 13:57:47 -0700 Message-Id: <20231020205759.195126-15-stephen@networkplumber.org> In-Reply-To: <20231020205759.195126-1-stephen@networkplumber.org> References: <20230808173527.186042-1-stephen@networkplumber.org> <20231020205759.195126-1-stephen@networkplumber.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: list Errors-To: dev-bounces@dpdk.org
Series	Promote many experimental API's to stable \| [v5,00/26] Promote many experimental API's to stable [v5,01/26] bpf: make rte_bpf_dump and rte_bpf_convert stable API's [v5,02/26] cmdline: make experimental API's stable [v5,03/26] ethdev: mark rte_tm API's as stable [v5,04/26] pdump: make API's stable [v5,05/26] pcapng: mark API's as stable [v5,06/26] net: remove experimental from functions [v5,07/26] rcu: remove experimental from rte_rcu_qbsr [v5,08/26] lpm: remove experimental [v5,09/26] mbuf: remove experimental from create_extbuf [v5,10/26] hash: remove experimental from toeplitz hash [v5,11/26] timer: remove experimental from rte_timer_next_ticks [v5,12/26] sched: remove experimental [v5,13/26] dmadev: mark API's as not experimental [v5,14/26] meter: remove experimental warning from comments [v5,15/26] power: remove experimental from API's [v5,16/26] kvargs: remove experimental flag [v5,17/26] ip_frag: mark a couple of functions stable [v5,18/26] member: remove experimental tag [v5,19/26] security: remove experimental flag from macsec [v5,20/26] bbdev: remove experimental tag [v5,21/26] ipsec: remove experimental from SA API [v5,22/26] compressdev: remove experimental flag [v5,23/26] regexdev: remove experimental tag [v5,24/26] node: remove some of the experimental tags [v5,25/26] eventdev: make many API's stable [v5,26/26] cryptodev: mark older API's stable

Checks

Context	Check	Description
ci/checkpatch	success	coding style OK

Commit Message

Stephen Hemminger Oct. 20, 2023, 8:57 p.m. UTC

  The API's for rte_meter_trtcm were never properly flagged
as experimental; missing __rte_experimental but there was
an experimental comment in the docbook comment.
Remove the comment.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
---
 lib/meter/rte_meter.h | 12 ------------
 1 file changed, 12 deletions(-)

Comments

David Marchand Oct. 23, 2023, 7:29 a.m. UTC | #1

On Fri, Oct 20, 2023 at 11:00 PM Stephen Hemminger
<stephen@networkplumber.org> wrote:
>
> The API's for rte_meter_trtcm were never properly flagged
> as experimental; missing __rte_experimental but there was
> an experimental comment in the docbook comment.
> Remove the comment.

While I don't object to this removal, I mentionned in previous mail
that this commitlog is wrong.
Those API were properly flagged as experimental.

I'll update the commitlog myself...

>
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
> Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>

Stephen Hemminger Oct. 24, 2023, 2:30 a.m. UTC | #2

On Mon, 23 Oct 2023 09:29:52 +0200
David Marchand <david.marchand@redhat.com> wrote:

> On Fri, Oct 20, 2023 at 11:00 PM Stephen Hemminger
> <stephen@networkplumber.org> wrote:
> >
> > The API's for rte_meter_trtcm were never properly flagged
> > as experimental; missing __rte_experimental but there was
> > an experimental comment in the docbook comment.
> > Remove the comment.  
> 
> While I don't object to this removal, I mentionned in previous mail
> that this commitlog is wrong.
> Those API were properly flagged as experimental.
> 
> I'll update the commitlog myself...

Look at rte_meter in main branch. For example:

/**
 * @warning
 * @b EXPERIMENTAL: this API may change without prior notice
 *
 * trTCM RFC 4115 profile configuration
 *
 * @param p
 *    Pointer to pre-allocated trTCM profile data structure
 * @param params
 *    trTCM profile parameters
 * @return
 *    0 upon success, error code otherwise
 */
int
rte_meter_trtcm_rfc4115_profile_config(
	struct rte_meter_trtcm_rfc4115_profile *p,
	struct rte_meter_trtcm_rfc4115_params *params);

The function is documented as experimental but the function
was not marked experimental in version.map or with __rte_experimental
attribute.  Will reword the commit message to clarify.

diff mbox series

Patch

diff --git a/lib/meter/rte_meter.h b/lib/meter/rte_meter.h
index 6ba99674361a..bd68cbe38903 100644
--- a/lib/meter/rte_meter.h
+++ b/lib/meter/rte_meter.h
@@ -124,9 +124,6 @@  int
 rte_meter_trtcm_profile_config(struct rte_meter_trtcm_profile *p,
 	struct rte_meter_trtcm_params *params);
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
- *
  * trTCM RFC 4115 profile configuration
  *
  * @param p
@@ -170,9 +167,6 @@  rte_meter_trtcm_config(struct rte_meter_trtcm *m,
 	struct rte_meter_trtcm_profile *p);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
- *
  * trTCM RFC 4115 configuration per metered traffic flow
  *
  * @param m
@@ -273,9 +267,6 @@  rte_meter_trtcm_color_aware_check(struct rte_meter_trtcm *m,
 	enum rte_color pkt_color);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
- *
  * trTCM RFC4115 color blind traffic metering
  *
  * @param m
@@ -297,9 +288,6 @@  rte_meter_trtcm_rfc4115_color_blind_check(
 	uint32_t pkt_len);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
- *
  * trTCM RFC4115 color aware traffic metering
  *
  * @param m