[dpdk-stable] patch 'doc: fix typos in ABI policy' has been queued to stable release 19.11.3

[luca.boccassi at gmail.com]

Hi,

FYI, your patch has been queued to stable release 19.11.3

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 05/24/20. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Thanks.

Luca Boccassi

---
>From 0b45ef6e391e82585f9fb7dc50fc5a52ab769347 Mon Sep 17 00:00:00 2001
From: Gaetan Rivet <grive at u256.net>
Date: Wed, 13 May 2020 12:43:01 +0200
Subject: [PATCH] doc: fix typos in ABI policy

[ upstream commit ec5c0f80e8c6894269d9a8a467f9f0ffb769a313 ]

Some errors in the document:

  * API instead of ABI once.

Some typos:

  * __rte_depreciated instead of __rte_deprecated.
  * missing ```` around value.
  * inconsistent reference to major ABI version, most
    of the time described without the minor appended, except once.

Verbosity and grammar:

  * Long sentences that would be better cut short.
  * Comma abuse.
  * 'May' used where 'can' seems more fitting.

I'm not a native speaker though, so grain of salt applies.

Fixes: fdf7471cccb8 ("doc: introduce major ABI versions")

Signed-off-by: Gaetan Rivet <grive at u256.net>
Acked-by: Ray Kinsella <mdr at ashroe.eu>
---
 doc/guides/contributing/abi_policy.rst | 21 ++++++++++-----------
 1 file changed, 10 insertions(+), 11 deletions(-)

diff --git a/doc/guides/contributing/abi_policy.rst b/doc/guides/contributing/abi_policy.rst
index 05ca95980b..2198519d9b 100644
--- a/doc/guides/contributing/abi_policy.rst
+++ b/doc/guides/contributing/abi_policy.rst
@@ -220,19 +220,18 @@ Examples of ABI Changes
 The following are examples of allowable ABI changes occurring between
 declarations of major ABI versions.
 
-* DPDK 19.11 release, defines the function ``rte_foo()``, and ``rte_foo()``
-  as part of the major ABI version ``20``.
+* DPDK 19.11 release defines the function ``rte_foo()`` ; ``rte_foo()``
+  is part of the major ABI version ``20``.
 
-* DPDK 20.02 release defines a new function ``rte_foo(uint8_t bar)``, and
-  this is not a problem as long as the symbol ``rte_foo at DPDK20`` is
+* DPDK 20.02 release defines a new function ``rte_foo(uint8_t bar)``.
+  This is not a problem as long as the symbol ``rte_foo at DPDK20`` is
   preserved through :ref:`abi_versioning`.
 
   - The new function may be marked with the ``__rte_experimental`` tag for a
     number of releases, as described in the section :ref:`experimental_apis`.
 
-  - Once ``rte_foo(uint8_t bar)`` becomes non-experimental ``rte_foo()`` is then
-    declared as ``__rte_depreciated``, with an associated deprecation notice
-    provided.
+  - Once ``rte_foo(uint8_t bar)`` becomes non-experimental, ``rte_foo()`` is
+    declared as ``__rte_deprecated`` and an deprecation notice is provided.
 
 * DPDK 19.11 is not re-released to include ``rte_foo(uint8_t bar)``, the new
   version of ``rte_foo`` only exists from DPDK 20.02 onwards as described in the
@@ -242,13 +241,13 @@ declarations of major ABI versions.
   rte_baz()``. This function may or may not exist in the DPDK 20.05 release.
 
 * An application ``dPacket`` wishes to use ``rte_foo(uint8_t bar)``, before the
-  declaration of the DPDK ``21`` major API version. The application can only
+  declaration of the DPDK ``21`` major ABI version. The application can only
   ensure its runtime dependencies are met by specifying ``DPDK (>= 20.2)`` as
-  an explicit package dependency, as the soname only may only indicate the
+  an explicit package dependency, as the soname can only indicate the
   supported major ABI version.
 
 * At the release of DPDK 20.11, the function ``rte_foo(uint8_t bar)`` becomes
-  formally part of then new major ABI version DPDK 21.0 and ``rte_foo()`` may be
+  formally part of then new major ABI version DPDK ``21`` and ``rte_foo()`` may be
   removed.
 
 .. _deprecation_notices:
@@ -322,6 +321,6 @@ Libraries
 
 Libraries marked as ``experimental`` are entirely not considered part of an ABI
 version, and may change without warning at any time. Experimental libraries
-always have a major version of ``0`` to indicate they exist outside of
+always have a major ABI version of ``0`` to indicate they exist outside of
 :ref:`abi_versioning` , with the minor version incremented with each ABI change
 to library.
-- 
2.20.1

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2020-05-22 10:37:40.620187250 +0100
+++ 0035-doc-fix-typos-in-ABI-policy.patch	2020-05-22 10:37:39.240414721 +0100
@@ -1,8 +1,10 @@
-From ec5c0f80e8c6894269d9a8a467f9f0ffb769a313 Mon Sep 17 00:00:00 2001
+From 0b45ef6e391e82585f9fb7dc50fc5a52ab769347 Mon Sep 17 00:00:00 2001
 From: Gaetan Rivet <grive at u256.net>
 Date: Wed, 13 May 2020 12:43:01 +0200
 Subject: [PATCH] doc: fix typos in ABI policy
 
+[ upstream commit ec5c0f80e8c6894269d9a8a467f9f0ffb769a313 ]
+
 Some errors in the document:
 
   * API instead of ABI once.
@@ -23,7 +25,6 @@
 I'm not a native speaker though, so grain of salt applies.
 
 Fixes: fdf7471cccb8 ("doc: introduce major ABI versions")
-Cc: stable at dpdk.org
 
 Signed-off-by: Gaetan Rivet <grive at u256.net>
 Acked-by: Ray Kinsella <mdr at ashroe.eu>
@@ -32,10 +33,10 @@
  1 file changed, 10 insertions(+), 11 deletions(-)
 
 diff --git a/doc/guides/contributing/abi_policy.rst b/doc/guides/contributing/abi_policy.rst
-index b921928689..ee17ccb200 100644
+index 05ca95980b..2198519d9b 100644
 --- a/doc/guides/contributing/abi_policy.rst
 +++ b/doc/guides/contributing/abi_policy.rst
-@@ -226,19 +226,18 @@ Examples of ABI Changes
+@@ -220,19 +220,18 @@ Examples of ABI Changes
  The following are examples of allowable ABI changes occurring between
  declarations of major ABI versions.
  
@@ -61,7 +62,7 @@
  
  * DPDK 19.11 is not re-released to include ``rte_foo(uint8_t bar)``, the new
    version of ``rte_foo`` only exists from DPDK 20.02 onwards as described in the
-@@ -248,13 +247,13 @@ declarations of major ABI versions.
+@@ -242,13 +241,13 @@ declarations of major ABI versions.
    rte_baz()``. This function may or may not exist in the DPDK 20.05 release.
  
  * An application ``dPacket`` wishes to use ``rte_foo(uint8_t bar)``, before the
@@ -78,7 +79,7 @@
    removed.
  
  .. _deprecation_notices:
-@@ -333,6 +332,6 @@ Libraries
+@@ -322,6 +321,6 @@ Libraries
  
  Libraries marked as ``experimental`` are entirely not considered part of an ABI
  version, and may change without warning at any time. Experimental libraries