DPDK patches and discussions
 help / color / mirror / Atom feed
From: John McNamara <john.mcnamara@intel.com>
To: dev@dpdk.org
Subject: [dpdk-dev] [PATCH v3 2/2] doc: rename release notes 2.3 to 16.04
Date: Wed, 10 Feb 2016 17:02:12 +0000	[thread overview]
Message-ID: <1455123732-1705-2-git-send-email-john.mcnamara@intel.com> (raw)
In-Reply-To: <1455123732-1705-1-git-send-email-john.mcnamara@intel.com>

From: "Richardson, Bruce" <bruce.richardson@intel.com>

Updated release documentation to reflect new numbering scheme.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
Signed-off-by: John McNamara <john.mcnamara@intel.com>
---
 doc/guides/rel_notes/index.rst         |   2 +-
 doc/guides/rel_notes/release_16_04.rst | 138 +++++++++++++++++++++++++++++++++
 doc/guides/rel_notes/release_2_3.rst   | 138 ---------------------------------
 3 files changed, 139 insertions(+), 139 deletions(-)
 create mode 100644 doc/guides/rel_notes/release_16_04.rst
 delete mode 100644 doc/guides/rel_notes/release_2_3.rst

diff --git a/doc/guides/rel_notes/index.rst b/doc/guides/rel_notes/index.rst
index 29013cf..84317b8 100644
--- a/doc/guides/rel_notes/index.rst
+++ b/doc/guides/rel_notes/index.rst
@@ -36,7 +36,7 @@ Release Notes
     :numbered:
 
     rel_description
-    release_2_3
+    release_16_04
     release_2_2
     release_2_1
     release_2_0
diff --git a/doc/guides/rel_notes/release_16_04.rst b/doc/guides/rel_notes/release_16_04.rst
new file mode 100644
index 0000000..27fc624
--- /dev/null
+++ b/doc/guides/rel_notes/release_16_04.rst
@@ -0,0 +1,138 @@
+DPDK Release 16.04
+==================
+
+
+**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_04.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.
+
+* **Virtio 1.0.**
+
+  Enabled virtio 1.0 support for virtio pmd driver.
+
+
+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
+~~~
+
+
+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.
+
+
+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.
+
+
+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.
+
+
+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
+
+     libethdev.so.2
+     librte_acl.so.2
+     librte_cfgfile.so.2
+     librte_cmdline.so.1
+     librte_distributor.so.1
+     librte_eal.so.2
+     librte_hash.so.2
+     librte_ip_frag.so.1
+     librte_ivshmem.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.1
+     librte_meter.so.1
+     librte_pipeline.so.2
+     librte_pmd_bond.so.1
+     librte_pmd_ring.so.2
+     librte_port.so.2
+     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.2
diff --git a/doc/guides/rel_notes/release_2_3.rst b/doc/guides/rel_notes/release_2_3.rst
deleted file mode 100644
index 7945694..0000000
--- a/doc/guides/rel_notes/release_2_3.rst
+++ /dev/null
@@ -1,138 +0,0 @@
-DPDK Release 2.3
-================
-
-
-**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_2_3.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.
-
-* **Virtio 1.0.**
-
-  Enabled virtio 1.0 support for virtio pmd driver.
-
-
-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
-~~~
-
-
-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.
-
-
-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.
-
-
-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.
-
-
-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
-
-     libethdev.so.2
-     librte_acl.so.2
-     librte_cfgfile.so.2
-     librte_cmdline.so.1
-     librte_distributor.so.1
-     librte_eal.so.2
-     librte_hash.so.2
-     librte_ip_frag.so.1
-     librte_ivshmem.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.1
-     librte_meter.so.1
-     librte_pipeline.so.2
-     librte_pmd_bond.so.1
-     librte_pmd_ring.so.2
-     librte_port.so.2
-     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.2
-- 
2.5.0

  reply	other threads:[~2016-02-10 17:03 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-12-21 13:26 [dpdk-dev] [PATCH 0/3] switch to using YY.MM version numbers Bruce Richardson
2015-12-21 13:26 ` [dpdk-dev] [PATCH 1/3] version: switch to year/month " Bruce Richardson
2016-02-10 14:33   ` [dpdk-dev] [PATCH v2 1/2] " John McNamara
2016-02-10 14:33     ` [dpdk-dev] [PATCH v2 2/2] doc: rename release notes 2.3 to 16.04 John McNamara
2016-02-10 15:11     ` [dpdk-dev] [PATCH v2 1/2] version: switch to year/month version numbers Thomas Monjalon
2016-02-10 15:31       ` Bruce Richardson
2016-02-10 16:52       ` Mcnamara, John
2015-12-21 13:26 ` [dpdk-dev] [PATCH 2/3] version: adjust printing for new version scheme Bruce Richardson
2015-12-28 22:25   ` Thomas Monjalon
2016-02-10 14:28     ` Mcnamara, John
2015-12-21 13:26 ` [dpdk-dev] [PATCH 3/3] doc: rename release 2.3 to 16.04 Bruce Richardson
2016-02-10 17:02 ` [dpdk-dev] [PATCH v3 1/2] version: switch to year/month version numbers John McNamara
2016-02-10 17:02   ` John McNamara [this message]
2016-02-10 17:11   ` Mcnamara, John
2016-02-10 17:20     ` Thomas Monjalon
2016-02-10 21:49   ` Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1455123732-1705-2-git-send-email-john.mcnamara@intel.com \
    --to=john.mcnamara@intel.com \
    --cc=dev@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).