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

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

[Thomas Monjalon]

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

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/rel_notes/index.rst         |   1 +
 doc/guides/rel_notes/release_18_08.rst | 192 +++++++++++++++++++++++++
 2 files changed, 193 insertions(+)
 create mode 100644 doc/guides/rel_notes/release_18_08.rst

diff --git a/doc/guides/rel_notes/index.rst b/doc/guides/rel_notes/index.rst
index eb82a0e06..d125342c3 100644
--- a/doc/guides/rel_notes/index.rst
+++ b/doc/guides/rel_notes/index.rst
@@ -9,6 +9,7 @@ Release Notes
     :numbered:
 
     rel_description
+    release_18_08
     release_18_05
     release_18_02
     release_17_11
diff --git a/doc/guides/rel_notes/release_18_08.rst b/doc/guides/rel_notes/release_18_08.rst
new file mode 100644
index 000000000..5bc23c537
--- /dev/null
+++ b/doc/guides/rel_notes/release_18_08.rst
@@ -0,0 +1,192 @@
+DPDK Release 18.08
+==================
+
+.. **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
+
+      xdg-open build/doc/html/guides/rel_notes/release_18_08.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.
+     =========================================================
+
+
+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 ``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.
+   =========================================================
+
+
+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 ``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.
+   =========================================================
+
+
+Removed Items
+-------------
+
+.. This section should contain removed items in this release. Sample format:
+
+   * 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.
+   =========================================================
+
+
+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_bbdev.so.1
+     librte_bitratestats.so.2
+     librte_bpf.so.1
+     librte_bus_dpaa.so.1
+     librte_bus_fslmc.so.1
+     librte_bus_pci.so.1
+     librte_bus_vdev.so.1
+     librte_cfgfile.so.2
+     librte_cmdline.so.2
+     librte_common_octeontx.so.1
+     librte_compressdev.so.1
+     librte_cryptodev.so.4
+     librte_distributor.so.1
+     librte_eal.so.7
+     librte_ethdev.so.9
+     librte_eventdev.so.4
+     librte_flow_classify.so.1
+     librte_gro.so.1
+     librte_gso.so.1
+     librte_hash.so.2
+     librte_ip_frag.so.1
+     librte_jobstats.so.1
+     librte_kni.so.2
+     librte_kvargs.so.1
+     librte_latencystats.so.1
+     librte_lpm.so.2
+     librte_mbuf.so.4
+     librte_mempool.so.4
+     librte_meter.so.2
+     librte_metrics.so.1
+     librte_net.so.1
+     librte_pci.so.1
+     librte_pdump.so.2
+     librte_pipeline.so.3
+     librte_pmd_bnxt.so.2
+     librte_pmd_bond.so.2
+     librte_pmd_i40e.so.2
+     librte_pmd_ixgbe.so.2
+     librte_pmd_dpaa2_cmdif.so.1
+     librte_pmd_dpaa2_qdma.so.1
+     librte_pmd_ring.so.2
+     librte_pmd_softnic.so.1
+     librte_pmd_vhost.so.2
+     librte_port.so.3
+     librte_power.so.1
+     librte_rawdev.so.1
+     librte_reorder.so.1
+     librte_ring.so.2
+     librte_sched.so.1
+     librte_security.so.1
+     librte_table.so.3
+     librte_timer.so.1
+     librte_vhost.so.3
+
+
+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.
+   =========================================================
+
+
+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.17.1

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

[Mcnamara, John]

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Thursday, May 31, 2018 10:11 PM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Kovacevic, Marko
> <marko.kovacevic@intel.com>
> Subject: [PATCH] doc: add template release notes for 18.08
> 
> Add template release notes for DPDK 18.08 with inline comments and
> explanations of the various sections.
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Merci.

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

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

[Thomas Monjalon]

> > Add template release notes for DPDK 18.08 with inline comments and
> > explanations of the various sections.
> > 
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> 
> Merci.

De rien :)

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

Applied

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

[Ferruh Yigit]

On 5/31/2018 10:11 PM, Thomas Monjalon wrote:
> Add template release notes for DPDK 18.08 with inline
> comments and explanations of the various sections.
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

<...>

> +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_bus_dpaa.so.1
> +     librte_bus_fslmc.so.1
> +     librte_bus_pci.so.1
> +     librte_bus_vdev.so.1
<..>
> +     librte_common_octeontx.so.1
<..>
> +     librte_pmd_dpaa2_cmdif.so.1
> +     librte_pmd_dpaa2_qdma.so.1

Is above libraries provide any API for user application?

It looks like they are for other internal libraries, if so should we document
them here in release notes?

Thanks,
ferruh

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

[Shreyansh Jain]

Hello Ferruh,

> -----Original Message-----
> From: Ferruh Yigit [mailto:ferruh.yigit@intel.com]
> Sent: Tuesday, June 5, 2018 2:34 PM
> To: Thomas Monjalon <thomas@monjalon.net>; dev@dpdk.org
> Cc: john.mcnamara@intel.com; marko.kovacevic@intel.com; Hemant Agrawal
> <hemant.agrawal@nxp.com>; Shreyansh Jain <shreyansh.jain@nxp.com>
> Subject: Re: [dpdk-dev] [PATCH] doc: add template release notes for
> 18.08
> 
> On 5/31/2018 10:11 PM, Thomas Monjalon wrote:
> > Add template release notes for DPDK 18.08 with inline
> > comments and explanations of the various sections.
> >
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> 
> <...>
> 
> > +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_bus_dpaa.so.1
> > +     librte_bus_fslmc.so.1
> > +     librte_bus_pci.so.1
> > +     librte_bus_vdev.so.1
> <..>
> > +     librte_common_octeontx.so.1
> <..>
> > +     librte_pmd_dpaa2_cmdif.so.1

cmdif doesn't expose any APIs for the user. It works through the librawdev APIs.

drivers/raw/dpaa2_cmdif/± cat rte_pmd_dpaa2_cmdif_version.map
DPDK_18.05 {

	local: *;
};

> > +     librte_pmd_dpaa2_qdma.so.1

QDMA driver indeed exposes various APIs for the user/application.

> 
> Is above libraries provide any API for user application?
> 
> It looks like they are for other internal libraries, if so should we
> document
> them here in release notes?

You are suggesting that we add a note stating a particular library has no exposed APIs? I can't guess what use that information would be for a release note reader.
That might be a note for the relevant documentation rst file, though.

> 
> Thanks,
> ferruh

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

[Ferruh Yigit]

On 6/5/2018 1:36 PM, Shreyansh Jain wrote:
> Hello Ferruh,
> 
>> -----Original Message-----
>> From: Ferruh Yigit [mailto:ferruh.yigit@intel.com]
>> Sent: Tuesday, June 5, 2018 2:34 PM
>> To: Thomas Monjalon <thomas@monjalon.net>; dev@dpdk.org
>> Cc: john.mcnamara@intel.com; marko.kovacevic@intel.com; Hemant Agrawal
>> <hemant.agrawal@nxp.com>; Shreyansh Jain <shreyansh.jain@nxp.com>
>> Subject: Re: [dpdk-dev] [PATCH] doc: add template release notes for
>> 18.08
>>
>> On 5/31/2018 10:11 PM, Thomas Monjalon wrote:
>>> Add template release notes for DPDK 18.08 with inline
>>> comments and explanations of the various sections.
>>>
>>> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
>>
>> <...>
>>
>>> +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_bus_dpaa.so.1
>>> +     librte_bus_fslmc.so.1
>>> +     librte_bus_pci.so.1
>>> +     librte_bus_vdev.so.1
>> <..>
>>> +     librte_common_octeontx.so.1
>> <..>
>>> +     librte_pmd_dpaa2_cmdif.so.1
> 
> cmdif doesn't expose any APIs for the user. It works through the librawdev APIs.
> 
> drivers/raw/dpaa2_cmdif/± cat rte_pmd_dpaa2_cmdif_version.map
> DPDK_18.05 {
> 
> 	local: *;
> };
> 
>>> +     librte_pmd_dpaa2_qdma.so.1
> 
> QDMA driver indeed exposes various APIs for the user/application.
> 
>>
>> Is above libraries provide any API for user application?
>>
>> It looks like they are for other internal libraries, if so should we
>> document
>> them here in release notes?
> 
> You are suggesting that we add a note stating a particular library has no exposed APIs? I can't guess what use that information would be for a release note reader.
> That might be a note for the relevant documentation rst file, though.

I suggest removing the library from release notes if it is only for internal
interface. Why user should concerned about version updates if the library is
internal only?

> 
>>
>> Thanks,
>> ferruh

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

[Shreyansh Jain]

On 6/5/2018 6:58 PM, Ferruh Yigit wrote:
> On 6/5/2018 1:36 PM, Shreyansh Jain wrote:
>> Hello Ferruh,
>>
>>> -----Original Message-----
>>> From: Ferruh Yigit [mailto:ferruh.yigit@intel.com]
>>> Sent: Tuesday, June 5, 2018 2:34 PM
>>> To: Thomas Monjalon <thomas@monjalon.net>; dev@dpdk.org
>>> Cc: john.mcnamara@intel.com; marko.kovacevic@intel.com; Hemant Agrawal
>>> <hemant.agrawal@nxp.com>; Shreyansh Jain <shreyansh.jain@nxp.com>
>>> Subject: Re: [dpdk-dev] [PATCH] doc: add template release notes for
>>> 18.08
>>>
>>> On 5/31/2018 10:11 PM, Thomas Monjalon wrote:
>>>> Add template release notes for DPDK 18.08 with inline
>>>> comments and explanations of the various sections.
>>>>
>>>> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
>>>
>>> <...>
>>>
>>>> +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_bus_dpaa.so.1
>>>> +     librte_bus_fslmc.so.1
>>>> +     librte_bus_pci.so.1
>>>> +     librte_bus_vdev.so.1
>>> <..>
>>>> +     librte_common_octeontx.so.1
>>> <..>
>>>> +     librte_pmd_dpaa2_cmdif.so.1
>>
>> cmdif doesn't expose any APIs for the user. It works through the librawdev APIs.
>>
>> drivers/raw/dpaa2_cmdif/± cat rte_pmd_dpaa2_cmdif_version.map
>> DPDK_18.05 {
>>
>> 	local: *;
>> };
>>
>>>> +     librte_pmd_dpaa2_qdma.so.1
>>
>> QDMA driver indeed exposes various APIs for the user/application.
>>
>>>
>>> Is above libraries provide any API for user application?
>>>
>>> It looks like they are for other internal libraries, if so should we
>>> document
>>> them here in release notes?
>>
>> You are suggesting that we add a note stating a particular library has no exposed APIs? I can't guess what use that information would be for a release note reader.
>> That might be a note for the relevant documentation rst file, though.
> 
> I suggest removing the library from release notes if it is only for internal
> interface. Why user should concerned about version updates if the library is
> internal only?

Are you referring to removing from 18.05 release note (published) as 
well? Or, you are only referring to removing from template for 18.08?

In principle, I have no objections in removing lib_pmd_dpaa2_cmdif from 
an exposed list of libraries as no application is going to use it directly.

-
Shreyansh

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

[Ferruh Yigit]

On 6/6/2018 7:19 AM, Shreyansh Jain wrote:
> On 6/5/2018 6:58 PM, Ferruh Yigit wrote:
>> On 6/5/2018 1:36 PM, Shreyansh Jain wrote:
>>> Hello Ferruh,
>>>
>>>> -----Original Message-----
>>>> From: Ferruh Yigit [mailto:ferruh.yigit@intel.com]
>>>> Sent: Tuesday, June 5, 2018 2:34 PM
>>>> To: Thomas Monjalon <thomas@monjalon.net>; dev@dpdk.org
>>>> Cc: john.mcnamara@intel.com; marko.kovacevic@intel.com; Hemant Agrawal
>>>> <hemant.agrawal@nxp.com>; Shreyansh Jain <shreyansh.jain@nxp.com>
>>>> Subject: Re: [dpdk-dev] [PATCH] doc: add template release notes for
>>>> 18.08
>>>>
>>>> On 5/31/2018 10:11 PM, Thomas Monjalon wrote:
>>>>> Add template release notes for DPDK 18.08 with inline
>>>>> comments and explanations of the various sections.
>>>>>
>>>>> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
>>>>
>>>> <...>
>>>>
>>>>> +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_bus_dpaa.so.1
>>>>> +     librte_bus_fslmc.so.1
>>>>> +     librte_bus_pci.so.1
>>>>> +     librte_bus_vdev.so.1
>>>> <..>
>>>>> +     librte_common_octeontx.so.1
>>>> <..>
>>>>> +     librte_pmd_dpaa2_cmdif.so.1
>>>
>>> cmdif doesn't expose any APIs for the user. It works through the librawdev APIs.
>>>
>>> drivers/raw/dpaa2_cmdif/± cat rte_pmd_dpaa2_cmdif_version.map
>>> DPDK_18.05 {
>>>
>>> 	local: *;
>>> };
>>>
>>>>> +     librte_pmd_dpaa2_qdma.so.1
>>>
>>> QDMA driver indeed exposes various APIs for the user/application.
>>>
>>>>
>>>> Is above libraries provide any API for user application?
>>>>
>>>> It looks like they are for other internal libraries, if so should we
>>>> document
>>>> them here in release notes?
>>>
>>> You are suggesting that we add a note stating a particular library has no exposed APIs? I can't guess what use that information would be for a release note reader.
>>> That might be a note for the relevant documentation rst file, though.
>>
>> I suggest removing the library from release notes if it is only for internal
>> interface. Why user should concerned about version updates if the library is
>> internal only?
> 
> Are you referring to removing from 18.05 release note (published) as 
> well? Or, you are only referring to removing from template for 18.08?

>From v18.08 an further, as a cleanup.

> 
> In principle, I have no objections in removing lib_pmd_dpaa2_cmdif from 
> an exposed list of libraries as no application is going to use it directly.
> 
> -
> Shreyansh
>