diff mbox

[dpdk-dev,v1] doc: fix sphinx highlighting warnings

Message ID 1468761114-1242-1-git-send-email-john.mcnamara@intel.com (mailing list archive)
State Accepted, archived
Headers

Commit Message

John McNamara July 17, 2016, 1:11 p.m. UTC 
Fix warnings raised by Python Sphinx 1.4.5:

    guides/sample_app_ug/ip_pipeline.rst:334:
    WARNING: Could not lex literal_block as "ini". Highlighting skipped.

    guides/sample_app_ug/l2_forward_real_virtual.rst:467:
    WARNING: Could not lex literal_block as "c". Highlighting skipped.

    guides/sample_app_ug/l3_forward.rst:293:
    WARNING: Could not lex literal_block as "c". Highlighting skipped.

    guides/sample_app_ug/vm_power_management.rst:162:
    WARNING: Could not lex literal_block as "xml". Highlighting skipped.

These warnings arise from invalid syntax in code-block directives.

    Fixes: f1e779ec5b50 ("doc: update ip pipeline app guide")
    Fixes: d0dff9ba445e ("doc: sample application user guide")
    Fixes: c75f4e6a7a2b ("doc: add vm power mgmt app")

Signed-off-by: John McNamara <john.mcnamara@intel.com>
---
 doc/guides/sample_app_ug/ip_pipeline.rst             | 2 +-
 doc/guides/sample_app_ug/l2_forward_real_virtual.rst | 2 +-
 doc/guides/sample_app_ug/l3_forward.rst              | 2 +-
 doc/guides/sample_app_ug/vm_power_management.rst     | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)

Comments

Thomas Monjalon July 22, 2016, 5:49 p.m. UTC | #1 
2016-07-17 14:11, John McNamara:
> Fix warnings raised by Python Sphinx 1.4.5:
> 
>     guides/sample_app_ug/ip_pipeline.rst:334:
>     WARNING: Could not lex literal_block as "ini". Highlighting skipped.
> 
>     guides/sample_app_ug/l2_forward_real_virtual.rst:467:
>     WARNING: Could not lex literal_block as "c". Highlighting skipped.
> 
>     guides/sample_app_ug/l3_forward.rst:293:
>     WARNING: Could not lex literal_block as "c". Highlighting skipped.
> 
>     guides/sample_app_ug/vm_power_management.rst:162:
>     WARNING: Could not lex literal_block as "xml". Highlighting skipped.
> 
> These warnings arise from invalid syntax in code-block directives.
> 
>     Fixes: f1e779ec5b50 ("doc: update ip pipeline app guide")
>     Fixes: d0dff9ba445e ("doc: sample application user guide")
>     Fixes: c75f4e6a7a2b ("doc: add vm power mgmt app")
> 
> Signed-off-by: John McNamara <john.mcnamara@intel.com>

Applied, thanks
diff mbox

Patch

diff --git a/doc/guides/sample_app_ug/ip_pipeline.rst b/doc/guides/sample_app_ug/ip_pipeline.rst
index 09cbc17..693d813 100644
--- a/doc/guides/sample_app_ug/ip_pipeline.rst
+++ b/doc/guides/sample_app_ug/ip_pipeline.rst
@@ -337,7 +337,7 @@  Generic example of configuration file section:
 
     <variable_name_1> = <value_1>
 
-    ...
+    ; ...
 
     <variable_name_N> = <value_N>
 
diff --git a/doc/guides/sample_app_ug/l2_forward_real_virtual.rst b/doc/guides/sample_app_ug/l2_forward_real_virtual.rst
index b51b2dc..a1c10c0 100644
--- a/doc/guides/sample_app_ug/l2_forward_real_virtual.rst
+++ b/doc/guides/sample_app_ug/l2_forward_real_virtual.rst
@@ -472,7 +472,7 @@  If the table is full, the whole packets table is transmitted using the l2fwd_sen
     l2fwd_send_packet(struct rte_mbuf *m, uint8_t port)
     {
         unsigned lcore_id, len;
-        struct lcore_queue_conf \*qconf;
+        struct lcore_queue_conf *qconf;
 
         lcore_id = rte_lcore_id();
         qconf = &lcore_queue_conf[lcore_id];
diff --git a/doc/guides/sample_app_ug/l3_forward.rst b/doc/guides/sample_app_ug/l3_forward.rst
index c885cdb..e2e6223 100644
--- a/doc/guides/sample_app_ug/l3_forward.rst
+++ b/doc/guides/sample_app_ug/l3_forward.rst
@@ -298,7 +298,7 @@  The get_ipv4_dst_port() function is shown below:
         int ret = 0;
         union ipv4_5tuple_host key;
 
-        ipv4_hdr = (uint8_t \*)ipv4_hdr + offsetof(struct ipv4_hdr, time_to_live);
+        ipv4_hdr = (uint8_t *)ipv4_hdr + offsetof(struct ipv4_hdr, time_to_live);
 
         m128i data = _mm_loadu_si128(( m128i*)(ipv4_hdr));
 
diff --git a/doc/guides/sample_app_ug/vm_power_management.rst b/doc/guides/sample_app_ug/vm_power_management.rst
index 7f299e0..aa02c15 100644
--- a/doc/guides/sample_app_ug/vm_power_management.rst
+++ b/doc/guides/sample_app_ug/vm_power_management.rst
@@ -167,7 +167,7 @@  Virtio-Serial channels are configured via libvirt XML:
   </controller>
   <channel type='unix'>
     <source mode='bind' path='/tmp/powermonitor/{vm_name}.{channel_num}'/>
-    <target type='virtio' name='virtio.serial.port.poweragent.{vm_channel_num}/>
+    <target type='virtio' name='virtio.serial.port.poweragent.{vm_channel_num}'/>
     <address type='virtio-serial' controller='0' bus='0' port='{N}'/>
   </channel>