diff mbox

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

Message ID 1435837927-23681-1-git-send-email-john.mcnamara@intel.com (mailing list archive)
State Superseded, archived
Headers

Commit Message

John McNamara July 2, 2015, 11:52 a.m. UTC 
  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@intel.com>
---
 doc/guides/guidelines/versioning.rst | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

Comments

Thomas Monjalon July 2, 2015, 12:18 p.m. UTC | #1 
2015-07-02 12:52, John McNamara:
> Also added a RST label to the start of the doc to allow it
> to be linked to from other docs.

We don't really need to have a label at the top of the doc.
It can be linked with :doc: role:
	dpdk.org/browse/dpdk/commit/?id=7cc2bdedd3812998078

But it could be useful in case new versioning chapters are added before
ABI guidelines.
In this case, the link referenced in the commit above should be updated.

> --- a/doc/guides/guidelines/versioning.rst
> +++ b/doc/guides/guidelines/versioning.rst
> @@ -1,3 +1,5 @@
> +.. abi_guidelines:
> +
>  Managing ABI updates
>  ====================
John McNamara July 2, 2015, 1:28 p.m. UTC | #2 
> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Thursday, July 2, 2015 1:18 PM
> To: Mcnamara, John
> Cc: dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH] doc: fix minor sphinx build warning
> 
> But it could be useful in case new versioning chapters are added before
> ABI guidelines.
> In this case, the link referenced in the commit above should be updated.

Hi Thomas,

I'll just resubmit without the label part of the patch and submit a patch for the label at a later stage, if required.

John
diff mbox

Patch

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
 -------------------------