diff mbox

[dpdk-dev] doc: fix incorrect indexing

Message ID 1493725498-11224-1-git-send-email-shreyansh.jain@nxp.com (mailing list archive)
State Accepted, archived
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Shreyansh Jain May 2, 2017, 11:44 a.m. UTC 
  Because of extra space before each list item, indexing numbers
generated by Sphinx were same.

Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>
---
**
 Current documentation has same numbering for top 3 list items, but
 thereafter numbering is correct even with space. Not sure what is
 wrong - but, removing space fixes complete indexing.

 Also, no MAINTAINER listing is appearing for this file
**

 doc/guides/prog_guide/extend_dpdk.rst | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

Comments

John McNamara May 2, 2017, 12:26 p.m. UTC | #1 
> -----Original Message-----
> From: Shreyansh Jain [mailto:shreyansh.jain@nxp.com]
> Sent: Tuesday, May 2, 2017 12:45 PM
> To: thomas@monjalon.net; Mcnamara, John <john.mcnamara@intel.com>
> Cc: dev@dpdk.org; Shreyansh Jain <shreyansh.jain@nxp.com>
> Subject: [PATCH] doc: fix incorrect indexing
> 
> Because of extra space before each list item, indexing numbers generated
> by Sphinx were same.
> 
> Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>

Acked-by: John McNamara <john.mcnamara@intel.com>
Thomas Monjalon May 7, 2017, 3:09 p.m. UTC | #2 
02/05/2017 14:26, Mcnamara, John:
> From: Shreyansh Jain [mailto:shreyansh.jain@nxp.com]
> > Because of extra space before each list item, indexing numbers generated
> > by Sphinx were same.
> > 
> > Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied, thanks
diff mbox

Patch

diff --git a/doc/guides/prog_guide/extend_dpdk.rst b/doc/guides/prog_guide/extend_dpdk.rst
index 51f0b5c..73d8199 100644
--- a/doc/guides/prog_guide/extend_dpdk.rst
+++ b/doc/guides/prog_guide/extend_dpdk.rst
@@ -39,14 +39,14 @@  Example: Adding a New Library libfoo
 
 To add a new library to the DPDK, proceed as follows:
 
-#.  Add a new configuration option:
+#. Add a new configuration option:
 
    .. code-block:: bash
 
         for f in config/\*; do \
             echo CONFIG_RTE_LIBFOO=y >> $f; done
 
-#.  Create a new directory with sources:
+#. Create a new directory with sources:
 
    .. code-block:: console
 
@@ -54,7 +54,7 @@  To add a new library to the DPDK, proceed as follows:
         touch ${RTE_SDK}/lib/libfoo/foo.c
         touch ${RTE_SDK}/lib/libfoo/foo.h
 
-#.  Add a foo() function in libfoo.
+#. Add a foo() function in libfoo.
 
     Definition is in foo.c:
 
@@ -71,7 +71,7 @@  To add a new library to the DPDK, proceed as follows:
         extern void foo(void);
 
 
-#.  Update lib/Makefile:
+#. Update lib/Makefile:
 
     .. code-block:: console
 
@@ -79,7 +79,7 @@  To add a new library to the DPDK, proceed as follows:
         # add:
         # DIRS-$(CONFIG_RTE_LIBFOO) += libfoo
 
-#.  Create a new Makefile for this library, for example, derived from mempool Makefile:
+#. Create a new Makefile for this library, for example, derived from mempool Makefile:
 
     .. code-block:: console
 
@@ -91,11 +91,11 @@  To add a new library to the DPDK, proceed as follows:
         # rte_mempool -> foo
 
 
-#.  Update mk/DPDK.app.mk, and add -lfoo in LDLIBS variable when the option is enabled.
-    This will automatically add this flag when linking a DPDK application.
+#. Update mk/DPDK.app.mk, and add -lfoo in LDLIBS variable when the option is enabled.
+   This will automatically add this flag when linking a DPDK application.
 
 
-#.  Build the DPDK with the new library (we only show a specific target here):
+#. Build the DPDK with the new library (we only show a specific target here):
 
     .. code-block:: console
 
@@ -104,7 +104,7 @@  To add a new library to the DPDK, proceed as follows:
         make
 
 
-#.  Check that the library is installed:
+#. Check that the library is installed:
 
     .. code-block:: console