From patchwork Sun Jul 19 10:52:14 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Monjalon X-Patchwork-Id: 6496 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id 34B48C32A; Sun, 19 Jul 2015 12:53:34 +0200 (CEST) Received: from mail-wi0-f178.google.com (mail-wi0-f178.google.com [209.85.212.178]) by dpdk.org (Postfix) with ESMTP id 436D6C324 for ; Sun, 19 Jul 2015 12:53:32 +0200 (CEST) Received: by wibud3 with SMTP id ud3so67779280wib.1 for ; Sun, 19 Jul 2015 03:53:31 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=6WinOVyZrnDJRUUF2/sROMTTZNMdqsXldrZNj8/x6qc=; b=gLtIbDJdTin0c21CXYnAOEvPjE7cDXOOsKb/7PuqDY6bHltx7V04yjdX2/lcpCRTNU YZd1ezmVbr1fgeD0VcGBtY4viYv3Rc3KlkgB301H9fLce1SsZMmMl3TCJkgOQN4FXD8f FQxKIRWew7WydDttHT5S7fRSvssAmMsiFK2KbB0TcNfhaqEQoIkfDShMZqlcSV12y4G8 /rDAq4zf5IcMjxKxHlwFAPhinWfWtURjTnc08rDnMwuYzitnjSlktd3iF/9LX5/ioVhK IaoLL+3ZclZLN31UXriZ0pjU2NAPoxkLC+CRyiUJLA6Yq3b3JC2NXMk8GQfVS7Ce0kwc 9KUA== X-Gm-Message-State: ALoCoQmSH0iXRFBxaT36AosRD6y7Bg0CrI13X2r7AJBICeaNDxBHfXJZsKRvDlXKz6WgslzoiPob X-Received: by 10.180.75.78 with SMTP id a14mr11763170wiw.43.1437303211874; Sun, 19 Jul 2015 03:53:31 -0700 (PDT) Received: from XPS13.localdomain (117.114.118.80.rev.sfr.net. [80.118.114.117]) by smtp.gmail.com with ESMTPSA id d5sm6481160wiz.24.2015.07.19.03.53.30 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Sun, 19 Jul 2015 03:53:31 -0700 (PDT) From: Thomas Monjalon To: dev@dpdk.org Date: Sun, 19 Jul 2015 12:52:14 +0200 Message-Id: <1437303137-29430-2-git-send-email-thomas.monjalon@6wind.com> X-Mailer: git-send-email 2.4.2 In-Reply-To: <1437303137-29430-1-git-send-email-thomas.monjalon@6wind.com> References: <1437303137-29430-1-git-send-email-thomas.monjalon@6wind.com> Subject: [dpdk-dev] [PATCH 1/4] doc: rename ABI chapter to deprecation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" This chapter is for ABI and API. That's why a renaming is required. Remove also the examples which are now in the referenced guidelines. Signed-off-by: Thomas Monjalon --- MAINTAINERS | 2 +- doc/guides/rel_notes/{abi.rst => deprecation.rst} | 16 +++++----------- doc/guides/rel_notes/index.rst | 2 +- 3 files changed, 7 insertions(+), 13 deletions(-) rename doc/guides/rel_notes/{abi.rst => deprecation.rst} (51%) diff --git a/MAINTAINERS b/MAINTAINERS index 2a32659..6531900 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -60,7 +60,7 @@ F: doc/guides/prog_guide/ext_app_lib_make_help.rst ABI versioning M: Neil Horman F: lib/librte_compat/ -F: doc/guides/rel_notes/abi.rst +F: doc/guides/rel_notes/deprecation.rst F: scripts/validate-abi.sh diff --git a/doc/guides/rel_notes/abi.rst b/doc/guides/rel_notes/deprecation.rst similarity index 51% rename from doc/guides/rel_notes/abi.rst rename to doc/guides/rel_notes/deprecation.rst index 7a08830..eef01f1 100644 --- a/doc/guides/rel_notes/abi.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -1,17 +1,11 @@ -ABI policy -========== +Deprecation +=========== See the :doc:`guidelines document for details of the ABI policy `. -ABI deprecation notices are to be posted here. +API and ABI deprecation notices are to be posted here. - -Examples of Deprecation Notices -------------------------------- - -* The Macro #RTE_FOO is deprecated and will be removed with version 2.0, to be replaced with the inline function rte_bar() -* The function rte_mbuf_grok has been updated to include new parameter in version 2.0. Backwards compatibility will be maintained for this function until the release of version 2.1 -* The members struct foo have been reorganized in release 2.0. Existing binary applications will have backwards compatibility in release 2.0, while newly built binaries will need to reference new structure variant struct foo2. Compatibility will be removed in release 2.2, and all applications will require updating and rebuilding to the new structure at that time, which will be renamed to the original struct foo. -* Significant ABI changes are planned for the librte_dostuff library. The upcoming release 2.0 will not contain these changes, but release 2.1 will, and no backwards compatibility is planned due to the invasive nature of these changes. Binaries using this library built prior to version 2.1 will require updating and recompilation. +Help to update from a previous release is provided in +:doc:`another section `. Deprecation Notices diff --git a/doc/guides/rel_notes/index.rst b/doc/guides/rel_notes/index.rst index d790783..9d66cd8 100644 --- a/doc/guides/rel_notes/index.rst +++ b/doc/guides/rel_notes/index.rst @@ -48,5 +48,5 @@ Contents updating_apps known_issues resolved_issues - abi + deprecation faq