From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <jmcnam2@ecsmtp.ir.intel.com>
Received: from mga09.intel.com (mga09.intel.com [134.134.136.24])
by dpdk.org (Postfix) with ESMTP id ADD641DB1
for <dev@dpdk.org>; Sun, 17 Jul 2016 15:11:57 +0200 (CEST)
Received: from fmsmga001.fm.intel.com ([10.253.24.23])
by orsmga102.jf.intel.com with ESMTP; 17 Jul 2016 06:11:56 -0700
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.28,378,1464678000"; d="scan'208";a="1008446644"
Received: from irvmail001.ir.intel.com ([163.33.26.43])
by fmsmga001.fm.intel.com with ESMTP; 17 Jul 2016 06:11:55 -0700
Received: from sivswdev02.ir.intel.com (sivswdev02.ir.intel.com
[10.237.217.46])
by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id
u6HDBtsu028558; Sun, 17 Jul 2016 14:11:55 +0100
Received: from sivswdev02.ir.intel.com (localhost [127.0.0.1])
by sivswdev02.ir.intel.com with ESMTP id u6HDBtgr001284;
Sun, 17 Jul 2016 14:11:55 +0100
Received: (from jmcnam2@localhost)
by sivswdev02.ir.intel.com with id u6HDBtFd001280;
Sun, 17 Jul 2016 14:11:55 +0100
From: John McNamara <john.mcnamara@intel.com>
To: dev@dpdk.org
Cc: John McNamara <john.mcnamara@intel.com>
Date: Sun, 17 Jul 2016 14:11:54 +0100
Message-Id: <1468761114-1242-1-git-send-email-john.mcnamara@intel.com>
X-Mailer: git-send-email 1.7.4.1
Subject: [dpdk-dev] [PATCH v1] doc: fix sphinx highlighting warnings
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Sun, 17 Jul 2016 13:11:58 -0000
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(-)
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>
--
2.7.4