Skip to content

Commit

Permalink
doc: remove template comments in old release notes
Browse files Browse the repository at this point in the history 
The release notes comments mention how to generate the documentation
with the old & removed build system.

Rather than fixing these comments, all old release notes comments
are removed, because they are useful only for the current release.

Few extra blank lines are removed for consistency.

Signed-off-by: Thomas Monjalon <[email protected]>
Acked-by: Bruce Richardson <[email protected]>
Acked-by: David Marchand <[email protected]>
Acked-by: John McNamara <[email protected]>
  • Loading branch information
@tmonjalo
tmonjalo committed Sep 23, 2021
1 parent 7a33572 commit 6d124f5
Show file tree
Hide file tree
Showing 24 changed files with 0 additions and 2,104 deletions.
1 change: 0 additions & 1 deletion doc/guides/rel_notes/release_16_04.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
DPDK Release 16.04
==================


New Features
------------

Expand Down
90 changes: 0 additions & 90 deletions doc/guides/rel_notes/release_16_07.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,39 +4,9 @@
DPDK Release 16.07
==================

.. **Read this first.**
The text 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_16_07.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.
* **Removed the mempool cache memory if caching is not being used.**

The size of the mempool structure is reduced if the per-lcore cache is disabled.
Expand Down Expand Up @@ -217,15 +187,6 @@ New Features
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.
EAL
~~~

Expand Down Expand Up @@ -289,33 +250,9 @@ Libraries
counter. This lead to a memory leak of the direct mbuf.


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.
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.
* The following counters are removed from the ``rte_eth_stats`` structure:

* ``ibadcrc``
Expand Down Expand Up @@ -354,10 +291,6 @@ API Changes
ABI Changes
-----------

.. * 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.
* The ``rte_port_source_params`` structure has new fields to support PCAP files.
It was already in release 16.04 with ``RTE_NEXT_ABI`` flag.

Expand All @@ -372,8 +305,6 @@ ABI Changes
Shared Library Versions
-----------------------

.. Update any library version updated in this release and prepend with a ``+`` sign.
The libraries prepended with a plus sign were incremented in this version.

.. code-block:: diff
Expand Down Expand Up @@ -412,16 +343,6 @@ The libraries prepended with a plus sign were incremented in this version.
Tested Platforms
----------------

.. This section should contain a list of platforms that were tested with this
release.
The format is:
#. Platform name.
- Platform details.
- Platform details.
#. SuperMicro 1U

- BIOS: 1.0c
Expand Down Expand Up @@ -472,15 +393,6 @@ Tested Platforms
Tested NICs
-----------

.. This section should contain a list of NICs that were tested with this release.
The format is:
#. NIC name.
- NIC details.
- NIC details.
#. Intel(R) Ethernet Controller X540-AT2

- Firmware version: 0x80000389
Expand Down Expand Up @@ -539,8 +451,6 @@ Tested NICs
Tested OSes
-----------

.. This section should contain a list of OSes that were tested with this release.
- CentOS 7.0
- Fedora 23
- Fedora 24
Expand Down
124 changes: 0 additions & 124 deletions doc/guides/rel_notes/release_16_11.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,42 +4,9 @@
DPDK Release 16.11
==================

.. **Read this first.**
The text 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_16_11.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. Make sure to start the actual text at the margin.
* **Added software parser for packet type.**

* Added a new function ``rte_pktmbuf_read()`` to read the packet data from an
Expand Down Expand Up @@ -159,20 +126,6 @@ New Features
The config option ``RTE_MACHINE`` can be used to pass code names to the compiler via the ``-march`` flag.


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. Make sure to start the actual text at the margin.
Drivers
~~~~~~~

Expand All @@ -183,19 +136,9 @@ Drivers
* **enic: Fixed high driver overhead when servicing Rx queues beyond the first.**



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. Make sure to start the actual text at the margin.
* **L3fwd-power app does not work properly when Rx vector is enabled.**

The L3fwd-power app doesn't work properly with some drivers in vector mode
Expand Down Expand Up @@ -223,13 +166,6 @@ Known Issues
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. Make sure to start the actual text at the margin.
* The driver naming convention has been changed to make them more
consistent. It especially impacts ``--vdev`` arguments. For example
``eth_pcap`` becomes ``net_pcap`` and ``cryptodev_aesni_mb_pmd`` becomes
Expand Down Expand Up @@ -273,32 +209,9 @@ API Changes
and ``rte_eal_vdrv_unregister``.


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. 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:
libethdev.so.4
librte_acl.so.2
+ librte_cfgfile.so.2
librte_cmdline.so.2
The libraries prepended with a plus sign were incremented in this version.

.. code-block:: diff
Expand Down Expand Up @@ -337,17 +250,6 @@ The libraries prepended with a plus sign were incremented in this version.
Tested Platforms
----------------

.. This section should contain a list of platforms that were tested with this release.
The format is:
#. Platform name.
* Platform details.
* Platform details.
This section is a comment. Make sure to start the actual text at the margin.
#. SuperMicro 1U

- BIOS: 1.0c
Expand Down Expand Up @@ -412,17 +314,6 @@ Tested Platforms
Tested NICs
-----------

.. This section should contain a list of NICs that were tested with this release.
The format is:
#. NIC name.
* NIC details.
* NIC details.
This section is a comment. Make sure to start the actual text at the margin.
#. Intel(R) Ethernet Controller X540-AT2

- Firmware version: 0x80000389
Expand Down Expand Up @@ -572,21 +463,6 @@ Tested NICs
Tested OSes
-----------

.. This section should contain a list of OSes that were tested with this release.
The format is as follows, in alphabetical order:
* CentOS 7.0
* Fedora 23
* Fedora 24
* FreeBSD 10.3
* Red Hat Enterprise Linux 7.2
* SUSE Enterprise Linux 12
* Ubuntu 15.10
* Ubuntu 16.04 LTS
* Wind River Linux 8
This section is a comment. Make sure to start the actual text at the margin.
* CentOS 7.2
* Fedora 23
* Fedora 24
Expand Down
Loading

0 comments on commit 6d124f5

Please sign in to comment.