[dpdk-dev] doc: fix code-block syntax

Message ID 1428422780-7079-1-git-send-email-thomas.monjalon@6wind.com (mailing list archive)
State Accepted, archived
Headers

Commit Message

Thomas Monjalon April 7, 2015, 4:06 p.m. UTC
  Some blocks are not visible with some Sphinx versions because
they are using the wrong keyword for code.

Tested with Sphinx v1.1.3.

Fixes: 1733be6d3147 ("doc: new eal multi-pthread feature")
Fixes: ccefe752cab0 ("doc: add jobstats sample guide")

Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
---
 doc/guides/prog_guide/env_abstraction_layer.rst   | 2 +-
 doc/guides/sample_app_ug/l2_forward_job_stats.rst | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)
  

Comments

Thomas Monjalon April 13, 2015, 7:55 p.m. UTC | #1
2015-04-07 18:06, Thomas Monjalon:
> Some blocks are not visible with some Sphinx versions because
> they are using the wrong keyword for code.
> 
> Tested with Sphinx v1.1.3.
> 
> Fixes: 1733be6d3147 ("doc: new eal multi-pthread feature")
> Fixes: ccefe752cab0 ("doc: add jobstats sample guide")
> 
> Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>

Applied
  

Patch

diff --git a/doc/guides/prog_guide/env_abstraction_layer.rst b/doc/guides/prog_guide/env_abstraction_layer.rst
index 1b531e2..06289ed 100644
--- a/doc/guides/prog_guide/env_abstraction_layer.rst
+++ b/doc/guides/prog_guide/env_abstraction_layer.rst
@@ -349,7 +349,7 @@  cgroup control
 The following is a simple example of cgroup control usage, there are two pthreads(t0 and t1) doing packet I/O on the same core ($CPU).
 We expect only 50% of CPU spend on packet IO.
 
-  .. code::
+  .. code-block:: console
 
     mkdir /sys/fs/cgroup/cpu/pkt_io
     mkdir /sys/fs/cgroup/cpuset/pkt_io
diff --git a/doc/guides/sample_app_ug/l2_forward_job_stats.rst b/doc/guides/sample_app_ug/l2_forward_job_stats.rst
index eafb8df..54d25cb 100644
--- a/doc/guides/sample_app_ug/l2_forward_job_stats.rst
+++ b/doc/guides/sample_app_ug/l2_forward_job_stats.rst
@@ -494,7 +494,7 @@  The rte_eth_rx_burst() function writes the mbuf pointers in a local table and re
 
 After first read second try is issued.
 
-.. code::
+.. code-block:: c
 
     if (total_nb_rx == MAX_PKT_BURST) {
         const uint16_t nb_rx = rte_eth_rx_burst((uint8_t) portid, 0, pkts_burst,
@@ -510,7 +510,7 @@  After first read second try is issued.
 
 This second read is important to give job stats library a feedback how many packets was processed.
 
-.. code::
+.. code-block:: c
 
     /* Adjust period time in which we are running here. */
     if (rte_jobstats_finish(job, total_nb_rx) != 0) {