[dpdk-dev,v2] doc: add suggested new feature order to release notes

Message ID 20180605134424.35529-1-ferruh.yigit@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Ferruh Yigit
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Ferruh Yigit June 5, 2018, 1:44 p.m. UTC
  Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
Cc: Shreyansh Jain <shreyansh.jain@nxp.com>

v2:
* Wording fixed
---
 doc/guides/rel_notes/release_18_08.rst | 3 +++
 1 file changed, 3 insertions(+)
  

Comments

John McNamara June 6, 2018, 9:46 a.m. UTC | #1
> -----Original Message-----
> From: Yigit, Ferruh
> Sent: Tuesday, June 5, 2018 2:44 PM
> To: Mcnamara, John <john.mcnamara@intel.com>; Kovacevic, Marko
> <marko.kovacevic@intel.com>
> Cc: dev@dpdk.org; Yigit, Ferruh <ferruh.yigit@intel.com>; Thomas Monjalon
> <thomas@monjalon.net>; Shreyansh Jain <shreyansh.jain@nxp.com>
> Subject: [PATCH v2] doc: add suggested new feature order to release notes
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> ---
> Cc: Shreyansh Jain <shreyansh.jain@nxp.com>
> 
> v2:
> * Wording fixed
> ---
>  doc/guides/rel_notes/release_18_08.rst | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/release_18_08.rst
> b/doc/guides/rel_notes/release_18_08.rst
> index 5bc23c537..bce01b550 100644
> --- a/doc/guides/rel_notes/release_18_08.rst
> +++ b/doc/guides/rel_notes/release_18_08.rst
> @@ -37,6 +37,9 @@ New Features
> 
>       Refer to the previous release notes for examples.
> 
> +     Suggested order of items in release note:
> +     core libs, device abstraction libs and PMDs, other libs, apps,
> examples, unit test

Good idea.

The line should be wrapped or maybe added as a list like this:

   * Core libs
   * Device abstraction libs and PMDs 
   * Other libs
   * Apps
   * Examples 
   * Unit tests

But that is minor, so.

Acked-by: John McNamara <john.mcnamara@intel.com>
  

Patch

diff --git a/doc/guides/rel_notes/release_18_08.rst b/doc/guides/rel_notes/release_18_08.rst
index 5bc23c537..bce01b550 100644
--- a/doc/guides/rel_notes/release_18_08.rst
+++ b/doc/guides/rel_notes/release_18_08.rst
@@ -37,6 +37,9 @@  New Features
 
      Refer to the previous release notes for examples.
 
+     Suggested order of items in release note:
+     core libs, device abstraction libs and PMDs, other libs, apps, examples, unit test
+
      This section is a comment. Do not overwrite or remove it.
      Also, make sure to start the actual text at the margin.
      =========================================================