[PATCH] doc: add suggested new feature order to release notes

[PATCH] doc: add suggested new feature order to release notes

[Ferruh Yigit]

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
 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..4229979b2 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 in release notes items:
+     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.
      =========================================================
-- 
2.14.3

Re: [PATCH] doc: add suggested new feature order to release notes

[Shreyansh Jain]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Ferruh Yigit
> Sent: Tuesday, June 5, 2018 2:52 PM
> To: John McNamara <john.mcnamara@intel.com>; Marko Kovacevic
> <marko.kovacevic@intel.com>
> Cc: dev@dpdk.org; Ferruh Yigit <ferruh.yigit@intel.com>; Thomas
> Monjalon <thomas@monjalon.net>
> Subject: [dpdk-dev] [PATCH] doc: add suggested new feature order to
> release notes
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> ---
>  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..4229979b2 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 in release notes items:

This is definitely a super nitpick, but:

        Suggested order of items in release note:

Feel free to completely ignore it.

> +     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.
>       =========================================================
> --
> 2.14.3

Re: [PATCH] doc: add suggested new feature order to release notes

[Ferruh Yigit]

On 6/5/2018 1:36 PM, Shreyansh Jain wrote:
>> -----Original Message-----
>> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Ferruh Yigit
>> Sent: Tuesday, June 5, 2018 2:52 PM
>> To: John McNamara <john.mcnamara@intel.com>; Marko Kovacevic
>> <marko.kovacevic@intel.com>
>> Cc: dev@dpdk.org; Ferruh Yigit <ferruh.yigit@intel.com>; Thomas
>> Monjalon <thomas@monjalon.net>
>> Subject: [dpdk-dev] [PATCH] doc: add suggested new feature order to
>> release notes
>>
>> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
>> ---
>>  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..4229979b2 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 in release notes items:
> 
> This is definitely a super nitpick, but:
> 
>         Suggested order of items in release note:
> 
> Feel free to completely ignore it.

I will send new version. Thank you for the comment, appreciated.

> 
>> +     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.
>>       =========================================================
>> --
>> 2.14.3
> 

[PATCH v2] doc: add suggested new feature order to release notes

[Ferruh Yigit]

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
+
      This section is a comment. Do not overwrite or remove it.
      Also, make sure to start the actual text at the margin.
      =========================================================
-- 
2.14.3

Re: [PATCH v2] doc: add suggested new feature order to release notes

[Mcnamara, John]

> -----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 v3] doc: add suggested new feature order to release notes

[Ferruh Yigit]

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
---
Cc: Shreyansh Jain <shreyansh.jain@nxp.com>

v2:
* Wording fixed

v3:
* Used suggested multi line format
* added abstraction layer and PMDs order
---
 doc/guides/rel_notes/release_18_08.rst | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/doc/guides/rel_notes/release_18_08.rst b/doc/guides/rel_notes/release_18_08.rst
index 5bc23c537..b6f0c030e 100644
--- a/doc/guides/rel_notes/release_18_08.rst
+++ b/doc/guides/rel_notes/release_18_08.rst
@@ -37,6 +37,15 @@ New Features
 
      Refer to the previous release notes for examples.
 
+     Suggested order in release notes items:
+     * Core libs
+     * Device abstraction libs and PMDs
+       + ethdev - ethdev PMDs, cryptodev - cryptodev PMDs, etc..
+     * Other libs
+     * Apps
+     * Examples
+     * Unit tests
+
      This section is a comment. Do not overwrite or remove it.
      Also, make sure to start the actual text at the margin.
      =========================================================
-- 
2.14.4