diff mbox

[dpdk-dev] doc: remove DPDK from guide titles

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

Commit Message

Thomas Monjalon Dec. 17, 2015, 11:15 a.m. UTC 
  In HTML and PDF guides, it is clear in the header that the doc
is related to the DPDK.
So "DPDK" is redundant and can be removed from FAQ and release notes
titles to improve consistency.

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

Comments

John McNamara Dec. 17, 2015, 2:39 p.m. UTC | #1 
> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Thursday, December 17, 2015 11:16 AM
> To: Mcnamara, John
> Cc: dev@dpdk.org
> Subject: [PATCH] doc: remove DPDK from guide titles
> 
> In HTML and PDF guides, it is clear in the header that the doc is related
> to the DPDK.
> So "DPDK" is redundant and can be removed from FAQ and release notes
> titles to improve consistency.
> 
> Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>

Good point.

Acked-by: John McNamara <john.mcnamara@intel.com>
Thomas Monjalon Dec. 17, 2015, 4:25 p.m. UTC | #2 
> > In HTML and PDF guides, it is clear in the header that the doc is related
> > to the DPDK.
> > So "DPDK" is redundant and can be removed from FAQ and release notes
> > titles to improve consistency.
> > 
> > Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
> 
> Good point.
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied
diff mbox

Patch

diff --git a/doc/guides/faq/index.rst b/doc/guides/faq/index.rst
index 6ca659f..264a3a9 100644
--- a/doc/guides/faq/index.rst
+++ b/doc/guides/faq/index.rst
@@ -28,8 +28,8 @@ 
     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-DPDK FAQ
-========
+FAQ
+===
 
 This document contains some Frequently Asked Questions that arise when working with DPDK.
 
diff --git a/doc/guides/rel_notes/index.rst b/doc/guides/rel_notes/index.rst
index 007308f..29013cf 100644
--- a/doc/guides/rel_notes/index.rst
+++ b/doc/guides/rel_notes/index.rst
@@ -28,8 +28,8 @@ 
     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-DPDK Release Notes
-==================
+Release Notes
+=============
 
 .. toctree::
     :maxdepth: 1