[dpdk-dev] doc: simplify release notes cover

Message ID 1439333928-31053-1-git-send-email-thomas.monjalon@6wind.com (mailing list archive)
State Accepted, archived
Headers

Commit Message

Thomas Monjalon Aug. 11, 2015, 10:58 p.m. UTC
  One hierarchical level is enough for this table of content.

Use generated release number.

Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
---
 doc/guides/rel_notes/index.rst           | 2 +-
 doc/guides/rel_notes/rel_description.rst | 5 ++---
 2 files changed, 3 insertions(+), 4 deletions(-)
  

Comments

John McNamara Aug. 12, 2015, 6:39 a.m. UTC | #1
> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Tuesday, August 11, 2015 11:59 PM
> To: Mcnamara, John
> Cc: dev@dpdk.org
> Subject: [PATCH] doc: simplify release notes cover
> 
> One hierarchical level is enough for this table of content.
> 
> Use generated release number.
> 
> Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>

Acked-by: John McNamara <john.mcnamara@intel.com>
  
Thomas Monjalon Aug. 12, 2015, 7:16 a.m. UTC | #2
> > One hierarchical level is enough for this table of content.
> > 
> > Use generated release number.
> > 
> > Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied
  

Patch

diff --git a/doc/guides/rel_notes/index.rst b/doc/guides/rel_notes/index.rst
index f0f97d1..d01cbc8 100644
--- a/doc/guides/rel_notes/index.rst
+++ b/doc/guides/rel_notes/index.rst
@@ -36,7 +36,7 @@  DPDK Release Notes
 Contents
 
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 1
     :numbered:
 
     rel_description
diff --git a/doc/guides/rel_notes/rel_description.rst b/doc/guides/rel_notes/rel_description.rst
index f240db1..994845f 100644
--- a/doc/guides/rel_notes/rel_description.rst
+++ b/doc/guides/rel_notes/rel_description.rst
@@ -32,10 +32,9 @@ 
 Description of Release
 ======================
 
-
-This document contains the release notes for Data Plane Development Kit (DPDK) release version 2.0.0 and previous releases.
+This document contains the release notes for Data Plane Development Kit (DPDK)
+release version |release| and previous releases.
 
 It lists new features, fixed bugs, API and ABI changes and known issues.
 
 For instructions on compiling and running the release, see the :ref:`DPDK Getting Started Guide <linux_gsg>`.
-