All of lore.kernel.org
 help / color / mirror / Atom feed
From: Ferruh Yigit <ferruh.yigit@intel.com>
To: Ferruh Yigit <ferruh.yigit@intel.com>,
	John McNamara <john.mcnamara@intel.com>,
	Marko Kovacevic <marko.kovacevic@intel.com>
Cc: dev@dpdk.org, Luca Boccassi <bluca@debian.org>,
	Kevin Traynor <ktraynor@redhat.com>,
	Yongseok Koh <yskoh@mellanox.com>,
	Neil Horman <nhorman@tuxdriver.com>
Subject: [PATCH v2 2/2] doc: add deprecation marker usage
Date: Fri, 21 Dec 2018 15:57:19 +0000	[thread overview]
Message-ID: <20181221155719.89773-2-ferruh.yigit@intel.com> (raw)
In-Reply-To: <20181221155719.89773-1-ferruh.yigit@intel.com>

Define '__rte_deprecated' usage process.

Suggests keeping old API with '__rte_deprecated' marker until next LTS.

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: Luca Boccassi <bluca@debian.org>
---
Cc: Luca Boccassi <bluca@debian.org>
Cc: Kevin Traynor <ktraynor@redhat.com>
Cc: Yongseok Koh <yskoh@mellanox.com>
Cc: Neil Horman <nhorman@tuxdriver.com>

v2:
* Rephrased as commented
---
 doc/guides/contributing/versioning.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst
index 19af56cd2..360238985 100644
--- a/doc/guides/contributing/versioning.rst
+++ b/doc/guides/contributing/versioning.rst
@@ -128,6 +128,16 @@ added to the Release Notes:
   these changes. Binaries using this library built prior to version 2.1 will
   require updating and recompilation.
 
+New API replacing previous one
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If a new API proposed functionally replaces an existing one, when the
+new API becomes active then the old one is marked with
+``__rte_deprecated`` until the next LTS. In the next LTS, the API is
+removed completely.
+
+Reminder that new API should follow deprecation process to become active.
+
 
 Experimental APIs
 -----------------
-- 
2.17.2

  reply	other threads:[~2018-12-21 15:57 UTC|newest]

Thread overview: 29+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-12-19 12:52 [RFC 1/2] doc: clean ABI/API policy guide Ferruh Yigit
2018-12-19 12:52 ` [RFC 2/2] doc: add deprecation marker usage Ferruh Yigit
2018-12-20  8:02   ` Luca Boccassi
2018-12-21 15:52     ` Ferruh Yigit
2018-12-20  8:02 ` [RFC 1/2] doc: clean ABI/API policy guide Luca Boccassi
2018-12-20  8:03 ` Luca Boccassi
2018-12-21 15:57 ` [PATCH v2 " Ferruh Yigit
2018-12-21 15:57   ` Ferruh Yigit [this message]
2019-01-22 16:23   ` [PATCH v3 1/3] " Ferruh Yigit
2019-01-22 16:23     ` [PATCH v3 2/3] doc: make RTE_NEXT_ABI optional Ferruh Yigit
2019-01-22 16:23     ` [PATCH v3 3/3] doc: add deprecation marker usage Ferruh Yigit
2019-01-23 23:07       ` Kevin Traynor
2019-01-24 14:31         ` Ferruh Yigit
2019-01-24 15:33           ` Kevin Traynor
2019-01-24 16:29             ` Ferruh Yigit
2019-01-23  8:13     ` [PATCH v3 1/3] doc: clean ABI/API policy guide Neil Horman
2019-01-24 18:10     ` [PATCH v4 " Ferruh Yigit
2019-01-24 18:10       ` [PATCH v4 2/3] doc: make RTE_NEXT_ABI optional Ferruh Yigit
2019-01-31 17:18         ` Thomas Monjalon
2019-01-24 18:10       ` [PATCH v4 3/3] doc: add deprecation marker usage Ferruh Yigit
2019-01-31 17:17         ` Thomas Monjalon
2019-02-01 17:06           ` Ferruh Yigit
2019-03-01 16:46             ` Thomas Monjalon
2019-01-31 17:46       ` [PATCH v4 1/3] doc: clean ABI/API policy guide Kevin Traynor
2019-03-01 17:32       ` [PATCH v5 " Ferruh Yigit
2019-03-01 17:32         ` [PATCH v5 2/3] doc: make RTE_NEXT_ABI optional Ferruh Yigit
2019-03-01 17:32         ` [PATCH v5 3/3] doc: add deprecation marker usage Ferruh Yigit
2019-03-01 17:40           ` Kevin Traynor
2019-03-27 13:29             ` Thomas Monjalon

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=20181221155719.89773-2-ferruh.yigit@intel.com \
    --to=ferruh.yigit@intel.com \
    --cc=bluca@debian.org \
    --cc=dev@dpdk.org \
    --cc=john.mcnamara@intel.com \
    --cc=ktraynor@redhat.com \
    --cc=marko.kovacevic@intel.com \
    --cc=nhorman@tuxdriver.com \
    --cc=yskoh@mellanox.com \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.