From: Thomas Monjalon <thomas@monjalon.net>
Date: Wed, 28 Nov 2018 14:52:40 +0000 (+0100)
Subject: doc: improve release notes template
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=7b2d0b3e779d3156d81043fe80d628b3285fee8e;p=dpdk.git

doc: improve release notes template

Some comments are added to encourage classifying API and ABI changes
with scope labels.

The section "removed items" is moved just after the "new features".

The sample for shared library versions is replaced with foo/bar names.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
---

diff --git a/doc/guides/rel_notes/release_19_02.rst b/doc/guides/rel_notes/release_19_02.rst
index cbb2ddb78c..a94fa86a7a 100644
--- a/doc/guides/rel_notes/release_19_02.rst
+++ b/doc/guides/rel_notes/release_19_02.rst
@@ -55,27 +55,27 @@ New Features
      =========================================================
 
 
-API Changes
------------
+Removed Items
+-------------
 
-.. This section should contain API changes. Sample format:
+.. This section should contain removed items in this release. Sample format:
 
-   * Add a short 1-2 sentence description of the API change.
-     Use fixed width quotes for ``function_names`` or ``struct_names``.
-     Use the past tense.
+   * Add a short 1-2 sentence description of the removed item
+     in the past tense.
 
    This section is a comment. Do not overwrite or remove it.
    Also, make sure to start the actual text at the margin.
    =========================================================
 
 
-ABI Changes
+API Changes
 -----------
 
-.. This section should contain ABI changes. Sample format:
+.. This section should contain API changes. Sample format:
 
-   * Add a short 1-2 sentence description of the ABI change
-     that was announced in the previous releases and made in this release.
+   * sample: Add a short 1-2 sentence description of the API change
+     which was announced in the previous releases and made in this release.
+     Start with a scope label like "ethdev:".
      Use fixed width quotes for ``function_names`` or ``struct_names``.
      Use the past tense.
 
@@ -84,13 +84,16 @@ ABI Changes
    =========================================================
 
 
-Removed Items
--------------
+ABI Changes
+-----------
 
-.. This section should contain removed items in this release. Sample format:
+.. This section should contain ABI changes. Sample format:
 
-   * Add a short 1-2 sentence description of the removed item
-     in the past tense.
+   * sample: Add a short 1-2 sentence description of the ABI change
+     which was announced in the previous releases and made in this release.
+     Start with a scope label like "ethdev:".
+     Use fixed width quotes for ``function_names`` or ``struct_names``.
+     Use the past tense.
 
    This section is a comment. Do not overwrite or remove it.
    Also, make sure to start the actual text at the margin.
@@ -103,9 +106,9 @@ Shared Library Versions
 .. Update any library version updated in this release
    and prepend with a ``+`` sign, like this:
 
-     librte_acl.so.2
-   + librte_cfgfile.so.2
-     librte_cmdline.so.2
+     libfoo.so.1
+   + libupdated.so.2
+     libbar.so.1
 
    This section is a comment. Do not overwrite or remove it.
    =========================================================