diff mbox

[dpdk-dev,10/11] doc: fix syntax in pmdinfogen guide

Message ID 1467905790-10597-11-git-send-email-thomas.monjalon@6wind.com (mailing list archive)
State Superseded, archived
Headers

Commit Message

Thomas Monjalon July 7, 2016, 3:36 p.m. UTC 
  Sphynx reports this error:

doc/guides/prog_guide/dev_kit_build_system.rst:337: WARNING:
Pygments lexer name u'C' is not known

Fixes: 737ddf3fb ("doc: add prog guide section documenting pmdinfo script")

Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
---
 doc/guides/prog_guide/dev_kit_build_system.rst | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

Comments

Thomas Monjalon July 7, 2016, 3:42 p.m. UTC | #1 
2016-07-07 17:36, Thomas Monjalon:
> Sphynx reports this error:
> 
> doc/guides/prog_guide/dev_kit_build_system.rst:337: WARNING:
> Pygments lexer name u'C' is not known
> 
> Fixes: 737ddf3fb ("doc: add prog guide section documenting pmdinfo script")
> 
> Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>

Reported-by: Bernard Iremonger <bernard.iremonger@intel.com>
Neil Horman July 7, 2016, 4:12 p.m. UTC | #2 
On Thu, Jul 07, 2016 at 05:36:29PM +0200, Thomas Monjalon wrote:
> Sphynx reports this error:
> 
> doc/guides/prog_guide/dev_kit_build_system.rst:337: WARNING:
> Pygments lexer name u'C' is not known
> 
> Fixes: 737ddf3fb ("doc: add prog guide section documenting pmdinfo script")
> 
> Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
> ---
>  doc/guides/prog_guide/dev_kit_build_system.rst | 5 ++---
>  1 file changed, 2 insertions(+), 3 deletions(-)
> 
> diff --git a/doc/guides/prog_guide/dev_kit_build_system.rst b/doc/guides/prog_guide/dev_kit_build_system.rst
> index 1dc1388..18a3010 100644
> --- a/doc/guides/prog_guide/dev_kit_build_system.rst
> +++ b/doc/guides/prog_guide/dev_kit_build_system.rst
> @@ -319,8 +319,7 @@ instance the macro:
>  
>  .. code-block:: c
>  
> -    PMD_REGISTER_DRIVER(drv, name)
> -
> +   PMD_REGISTER_DRIVER(drv, name)
>  
>  Creates the following symbol:
>  
> @@ -334,7 +333,7 @@ can be exported from the object file and used to produce a hardware support
>  description, that pmdinfogen then encodes into a json formatted string in the
>  following format:
>  
> -.. code-block:: C
> +.. code-block:: c
>  
>     static char <name_pmd_string>="PMD_INFO_STRING=\"{'name' : '<name>', ...}\"";
>  
> -- 
> 2.7.0
> 
> 
Acked-by: Neil Horman <nhorman@tuxdriver.com>
diff mbox

Patch

diff --git a/doc/guides/prog_guide/dev_kit_build_system.rst b/doc/guides/prog_guide/dev_kit_build_system.rst
index 1dc1388..18a3010 100644
--- a/doc/guides/prog_guide/dev_kit_build_system.rst
+++ b/doc/guides/prog_guide/dev_kit_build_system.rst
@@ -319,8 +319,7 @@  instance the macro:
 
 .. code-block:: c
 
-    PMD_REGISTER_DRIVER(drv, name)
-
+   PMD_REGISTER_DRIVER(drv, name)
 
 Creates the following symbol:
 
@@ -334,7 +333,7 @@  can be exported from the object file and used to produce a hardware support
 description, that pmdinfogen then encodes into a json formatted string in the
 following format:
 
-.. code-block:: C
+.. code-block:: c
 
    static char <name_pmd_string>="PMD_INFO_STRING=\"{'name' : '<name>', ...}\"";