[dpdk-dev] [PATCH] doc: fix minor sphinx build warning

John McNamara john.mcnamara at intel.com
Thu Jul 2 13:52:07 CEST 2015


Fix for a minor Sphinx build warning in the ABI guidelines docs:

    versioning.rst:126: WARNING: Bullet list ends without a
                        blank line; unexpected unindent.

Also added a RST label to the start of the doc to allow it
to be linked to from other docs.

Signed-off-by: John McNamara <john.mcnamara at intel.com>
---
 doc/guides/guidelines/versioning.rst | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/doc/guides/guidelines/versioning.rst b/doc/guides/guidelines/versioning.rst
index a1c9368..57db6fd 100644
--- a/doc/guides/guidelines/versioning.rst
+++ b/doc/guides/guidelines/versioning.rst
@@ -1,3 +1,5 @@
+.. abi_guidelines:
+
 Managing ABI updates
 ====================
 
@@ -122,9 +124,9 @@ The macros exported are:
   the linker to bind references to symbol ``b`` to the internal symbol
   ``b_e``.
 
-* ``MAP_STATIC_SYMBOL(f, p)``: Declare the prototype ``f``, and map it to the fully
-qualified function ``p``, so that if a symbol becomes versioned, it can still be
-mapped back to the public symbol name.
+* ``MAP_STATIC_SYMBOL(f, p)``: Declare the prototype ``f``, and map it to the
+  fully qualified function ``p``, so that if a symbol becomes versioned, it
+  can still be mapped back to the public symbol name.
 
 Examples of ABI Macro use
 -------------------------
-- 
1.8.1.4



More information about the dev mailing list