From: John McNamara <hidden> Date: 2017-11-17 22:41:38
Add template release notes for DPDK 18.02 with inline
comments and explanations of the various sections.
Signed-off-by: John McNamara <redacted>
---
doc/guides/rel_notes/release_18_02.rst | 214 +++++++++++++++++++++++++++++++++
1 file changed, 214 insertions(+)
create mode 100644 doc/guides/rel_notes/release_18_02.rst
@@ -0,0 +1,214 @@+DPDK Release 18.02+==================++.. **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_02.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_bitratestats.so.2+ 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_cryptodev.so.4+ librte_distributor.so.1+ librte_eal.so.6+ librte_ethdev.so.8+ librte_eventdev.so.3+ 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.3+ librte_mempool.so.3+ librte_meter.so.1+ 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_ring.so.2+ librte_pmd_softnic.so.1+ librte_pmd_vhost.so.2+ librte_port.so.3+ librte_power.so.1+ librte_reorder.so.1+ librte_ring.so.1+ librte_sched.so.1+ librte_security.so.1+ librte_table.so.3+ 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.+ =========================================================
From: Thomas Monjalon <hidden> Date: 2017-11-22 11:06:34
Hi,
17/11/2017 23:41, John McNamara:
quoted hunk
+Resolved Issues+---------------++.. This section should contain bug fixes added to the relevant+ sections. Sample format:
I am not sure about this section.
It is really too hard to maintain it.
We have only few fixes referenced here.
The consequence is to make readers think not a lot of things were fixed.
One more comment, may we keep the section "Removed Items" introduced in 17.11?
From: Mcnamara, John <hidden> Date: 2017-11-22 17:36:14
-----Original Message-----
From: Thomas Monjalon [mailto:thomas@monjalon.net]
Sent: Wednesday, November 22, 2017 11:07 AM
To: Mcnamara, John <redacted>
Cc: dev@dpdk.org
Subject: Re: [dpdk-dev] [PATCH v1] doc: add template release notes for
18.02
Hi,
17/11/2017 23:41, John McNamara:
quoted
+Resolved Issues+---------------++.. This section should contain bug fixes added to the relevant+ sections. Sample format:
I am not sure about this section.
It is really too hard to maintain it.
We have only few fixes referenced here.
The consequence is to make readers think not a lot of things were fixed.
Ok. Let's remove it. I should be possible to generate a list of fixed issues
from Bugzilla if we track them there. Or just have a link to a query on Bugzilla.
To do that we will have to start using Bugzilla.
One more comment, may we keep the section "Removed Items" introduced in
17.11?
@@ -0,0 +1,186 @@+DPDK Release 18.02+==================++.. **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_02.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 ``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.+ =========================================================+++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.+ =========================================================+++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.+ =========================================================+++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_bitratestats.so.2+ 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_cryptodev.so.4+ librte_distributor.so.1+ librte_eal.so.6+ librte_ethdev.so.8+ librte_eventdev.so.3+ 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.3+ librte_mempool.so.3+ librte_meter.so.1+ 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_ring.so.2+ librte_pmd_softnic.so.1+ librte_pmd_vhost.so.2+ librte_port.so.3+ librte_power.so.1+ librte_reorder.so.1+ librte_ring.so.1+ librte_sched.so.1+ librte_security.so.1+ librte_table.so.3+ 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.+ =========================================================
From: Thomas Monjalon <hidden> Date: 2017-11-23 22:34:43
22/11/2017 18:38, John McNamara:
Add template release notes for DPDK 18.02 with inline
comments and explanations of the various sections.
Signed-off-by: John McNamara <redacted>
---
V2: Added "Removed Items" and removed "Resolved Issues".
doc/guides/rel_notes/release_18_02.rst | 186 +++++++++++++++++++++++++++++++++
1 file changed, 186 insertions(+)