[dpdk-dev] [PATCH v1] doc: add template release notes for 17.05

[dpdk-dev] [PATCH v1] doc: add template release notes for 17.05

[John McNamara]

Add template release notes for DPDK 17.05 with inline
comments and explanations of the various sections.

Signed-off-by: John McNamara <john.mcnamara@intel.com>
---
 doc/guides/rel_notes/index.rst         |   1 +
 doc/guides/rel_notes/release_17_05.rst | 195 +++++++++++++++++++++++++++++++++
 2 files changed, 196 insertions(+)
 create mode 100644 doc/guides/rel_notes/release_17_05.rst

diff --git a/doc/guides/rel_notes/index.rst b/doc/guides/rel_notes/index.rst
index cf8f167..c4d243c 100644
--- a/doc/guides/rel_notes/index.rst
+++ b/doc/guides/rel_notes/index.rst
@@ -36,6 +36,7 @@ Release Notes
     :numbered:
 
     rel_description
+    release_17_05
     release_17_02
     release_16_11
     release_16_07
diff --git a/doc/guides/rel_notes/release_17_05.rst b/doc/guides/rel_notes/release_17_05.rst
new file mode 100644
index 0000000..e5a0a9e
--- /dev/null
+++ b/doc/guides/rel_notes/release_17_05.rst
@@ -0,0 +1,195 @@
+DPDK Release 17.05
+==================
+
+.. **Read this first.**
+
+   The text in the sections below explains how to update the release notes.
+
+   Use proper spelling, capitalization and punctuation in all sections.
+
+   Variable and config names should be quoted as fixed width text:
+   ``LIKE_THIS``.
+
+   Build the docs and view the output file to ensure the changes are correct::
+
+      make doc-guides-html
+
+      firefox build/doc/html/guides/rel_notes/release_17_05.html
+
+
+New Features
+------------
+
+.. This section should contain new features added in this release. Sample
+   format:
+
+   * **Add a title in the past tense with a full stop.**
+
+     Add a short 1-2 sentence description in the past tense. The description
+     should be enough to allow someone scanning the release notes to
+     understand the new feature.
+
+     If the feature adds a lot of sub-features you can use a bullet list like
+     this:
+
+     * Added feature foo to do something.
+     * Enhanced feature bar to do something else.
+
+     Refer to the previous release notes for examples.
+
+     This section is a comment. do not overwrite or remove it.
+     Also, make sure to start the actual text at the margin.
+     =========================================================
+
+
+Resolved Issues
+---------------
+
+.. This section should contain bug fixes added to the relevant
+   sections. Sample format:
+
+   * **code/section Fixed issue in the past tense with a full stop.**
+
+     Add a short 1-2 sentence description of the resolved issue in the past
+     tense.
+
+     The title should contain the code/lib section like a commit message.
+
+     Add the entries in alphabetic order in the relevant sections below.
+
+   This section is a comment. do not overwrite or remove it.
+   Also, make sure to start the actual text at the margin.
+   =========================================================
+
+
+EAL
+~~~
+
+
+Drivers
+~~~~~~~
+
+
+Libraries
+~~~~~~~~~
+
+
+Examples
+~~~~~~~~
+
+
+Other
+~~~~~
+
+
+Known Issues
+------------
+
+.. This section should contain new known issues in this release. Sample format:
+
+   * **Add title in present tense with full stop.**
+
+     Add a short 1-2 sentence description of the known issue in the present
+     tense. Add information on any known workarounds.
+
+   This section is a comment. do not overwrite or remove it.
+   Also, make sure to start the actual text at the margin.
+   =========================================================
+
+
+API Changes
+-----------
+
+.. This section should contain API changes. Sample format:
+
+   * Add a short 1-2 sentence description of the API change. Use fixed width
+     quotes for ``rte_function_names`` or ``rte_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.
+   =========================================================
+
+
+ABI Changes
+-----------
+
+.. This section should contain ABI 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. Use fixed width quotes
+     for ``rte_function_names`` or ``rte_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.
+   =========================================================
+
+
+
+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
+
+   This section is a comment. do not overwrite or remove it.
+   =========================================================
+
+
+The libraries prepended with a plus sign were incremented in this version.
+
+.. code-block:: diff
+
+     librte_acl.so.2
+     librte_cfgfile.so.2
+     librte_cmdline.so.2
+     librte_cryptodev.so.2
+     librte_distributor.so.1
+     librte_eal.so.3
+     librte_ethdev.so.6
+     librte_hash.so.2
+     librte_ip_frag.so.1
+     librte_jobstats.so.1
+     librte_kni.so.2
+     librte_kvargs.so.1
+     librte_lpm.so.2
+     librte_mbuf.so.2
+     librte_mempool.so.2
+     librte_meter.so.1
+     librte_net.so.1
+     librte_pdump.so.1
+     librte_pipeline.so.3
+     librte_pmd_bond.so.1
+     librte_pmd_ring.so.2
+     librte_port.so.3
+     librte_power.so.1
+     librte_reorder.so.1
+     librte_ring.so.1
+     librte_sched.so.1
+     librte_table.so.2
+     librte_timer.so.1
+     librte_vhost.so.3
+
+
+Tested Platforms
+----------------
+
+.. This section should contain a list of platforms that were tested with this
+   release.
+
+   The format is:
+
+   * <vendor> platform with <vendor> <type of devices> combinations
+
+     * List of CPU
+     * List of OS
+     * List of devices
+     * Other relevant details...
+
+   This section is a comment. do not overwrite or remove it.
+   Also, make sure to start the actual text at the margin.
+   =========================================================
-- 
2.7.4

Re: [dpdk-dev] [PATCH v1] doc: add template release notes for 17.05

[Bruce Richardson]

On Wed, Feb 15, 2017 at 12:38:58PM +0000, John McNamara wrote:
> Add template release notes for DPDK 17.05 with inline
> comments and explanations of the various sections.
> 
> Signed-off-by: John McNamara <john.mcnamara@intel.com>
> ---
>  doc/guides/rel_notes/index.rst         |   1 +
>  doc/guides/rel_notes/release_17_05.rst | 195 +++++++++++++++++++++++++++++++++
>  2 files changed, 196 insertions(+)
>  create mode 100644 doc/guides/rel_notes/release_17_05.rst
> 

Acked-by: Bruce Richardson <bruce.ricahrdson@intel.com>

Re: [dpdk-dev] [PATCH v1] doc: add template release notes for 17.05

[Thomas Monjalon]

2017-02-15 12:38, John McNamara:
> +   Build the docs and view the output file to ensure the changes are correct::
> +
> +      make doc-guides-html
> +
> +      firefox build/doc/html/guides/rel_notes/release_17_05.html

I would suggest xdg-open instead of firefox.
It is more open regarding chromium ;)

Re: [dpdk-dev] [PATCH v1] doc: add template release notes for 17.05

[Mcnamara, John]

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Wednesday, February 15, 2017 2:55 PM
> To: Mcnamara, John <john.mcnamara@intel.com>
> Cc: dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH v1] doc: add template release notes for
> 17.05
> 
> 2017-02-15 12:38, John McNamara:
> > +   Build the docs and view the output file to ensure the changes are
> correct::
> > +
> > +      make doc-guides-html
> > +
> > +      firefox build/doc/html/guides/rel_notes/release_17_05.html
> 
> I would suggest xdg-open instead of firefox.
> It is more open regarding chromium ;)

I generally use xdg-open, which in my case gives me midori but for the
docs it is probably better to have something that is easily recognizable
as a browser. Either way I'm okay if you wish to make the change inline
during merge. Or would you prefer a V2.

John

Re: [dpdk-dev] [PATCH v1] doc: add template release notes for 17.05

[Thomas Monjalon]

2017-02-16 15:01, Mcnamara, John:
> 
> > -----Original Message-----
> > From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > Sent: Wednesday, February 15, 2017 2:55 PM
> > To: Mcnamara, John <john.mcnamara@intel.com>
> > Cc: dev@dpdk.org
> > Subject: Re: [dpdk-dev] [PATCH v1] doc: add template release notes for
> > 17.05
> > 
> > 2017-02-15 12:38, John McNamara:
> > > +   Build the docs and view the output file to ensure the changes are
> > correct::
> > > +
> > > +      make doc-guides-html
> > > +
> > > +      firefox build/doc/html/guides/rel_notes/release_17_05.html
> > 
> > I would suggest xdg-open instead of firefox.
> > It is more open regarding chromium ;)
> 
> I generally use xdg-open, which in my case gives me midori but for the
> docs it is probably better to have something that is easily recognizable
> as a browser. Either way I'm okay if you wish to make the change inline
> during merge. Or would you prefer a V2.

Midori? Seems another interesting choice:)

Applied with this change, thanks