[dpdk-dev,1/3] docs: change hardcoded date to auto-generated

Message ID 1416839034-26652-2-git-send-email-bruce.richardson@intel.com (mailing list archive)
State Accepted, archived
Headers

Commit Message

Bruce Richardson Nov. 24, 2014, 2:23 p.m. UTC
  The index.html file for each of the "guide" docs had a hard-coded
date value in them of June 2014. Rather than update each of these
for each revision, just use the |today| directive to insert the date
at which the document was generated.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/freebsd_gsg/index.rst    | 2 +-
 doc/guides/linux_gsg/index.rst      | 2 +-
 doc/guides/prog_guide/index.rst     | 2 +-
 doc/guides/rel_notes/index.rst      | 2 +-
 doc/guides/sample_app_ug/index.rst  | 2 +-
 doc/guides/testpmd_app_ug/index.rst | 2 +-
 6 files changed, 6 insertions(+), 6 deletions(-)
  

Comments

Iremonger, Bernard Nov. 26, 2014, 10:38 a.m. UTC | #1
> -----Original Message-----
> Subject: [dpdk-dev] [PATCH 1/3] docs: change hardcoded date to auto-generated
> 
> The index.html file for each of the "guide" docs had a hard-coded date value in them of June 2014.
> Rather than update each of these for each revision, just use the |today| directive to insert the date at
> which the document was generated.
> 
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>

Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>

 I have applied the patch to my tree next/dpdk-doc.
  

Patch

diff --git a/doc/guides/freebsd_gsg/index.rst b/doc/guides/freebsd_gsg/index.rst
index da5be85..90915a8 100644
--- a/doc/guides/freebsd_gsg/index.rst
+++ b/doc/guides/freebsd_gsg/index.rst
@@ -31,7 +31,7 @@ 
 Getting Started Guide for FreeBSD
 =================================
 
-June 2014
+|today|
 
 INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS.
 NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT.
diff --git a/doc/guides/linux_gsg/index.rst b/doc/guides/linux_gsg/index.rst
index 11ee387..d4b7c97 100644
--- a/doc/guides/linux_gsg/index.rst
+++ b/doc/guides/linux_gsg/index.rst
@@ -31,7 +31,7 @@ 
 Getting Started Guide
 =====================
 
-June 2014
+|today|
 
 INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS.
 NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT.
diff --git a/doc/guides/prog_guide/index.rst b/doc/guides/prog_guide/index.rst
index e0ac8f4..78016d7 100644
--- a/doc/guides/prog_guide/index.rst
+++ b/doc/guides/prog_guide/index.rst
@@ -31,7 +31,7 @@ 
 Programmer's Guide
 ==================
 
-June 2014
+|today|
 
 
 INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS. NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE,
diff --git a/doc/guides/rel_notes/index.rst b/doc/guides/rel_notes/index.rst
index 347f67b..e9a3d21 100644
--- a/doc/guides/rel_notes/index.rst
+++ b/doc/guides/rel_notes/index.rst
@@ -33,7 +33,7 @@  Release Notes
 
 Package Version: 1.7
 
-June 2014
+|today|
 
 INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS.
 NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT.
diff --git a/doc/guides/sample_app_ug/index.rst b/doc/guides/sample_app_ug/index.rst
index ad2ca28..7555bce 100644
--- a/doc/guides/sample_app_ug/index.rst
+++ b/doc/guides/sample_app_ug/index.rst
@@ -31,7 +31,7 @@ 
 Sample Applications User Guide
 ==============================
 
-June 2014
+|today|
 
 INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS.
 NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT.
diff --git a/doc/guides/testpmd_app_ug/index.rst b/doc/guides/testpmd_app_ug/index.rst
index e89fad6..d1ad182 100644
--- a/doc/guides/testpmd_app_ug/index.rst
+++ b/doc/guides/testpmd_app_ug/index.rst
@@ -31,7 +31,7 @@ 
 Testpmd Application User Guide
 ==============================
 
-June 2014
+|today|
 
 INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS.
 NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT.