[V1] doc/*: fix some document buld warning info.

Message ID 20220128062226.916-1-junx.dong@intel.com (mailing list archive)
State Accepted
Headers
Series [V1] doc/*: fix some document buld warning info. |

Checks

Context Check Description
ci/Intel-dts-doc-test success Testing OK
ci/Intel-dts-suite-test warning SKIPPED

Commit Message

Jun Dong Jan. 28, 2022, 6:22 a.m. UTC
  Signed-off-by: Jun Dong <junx.dong@intel.com>
---
 doc/dts_gsg/quick_start.rst    | 4 ++--
 doc/dts_gsg/usr_guide/trex.rst | 6 +++---
 2 files changed, 5 insertions(+), 5 deletions(-)
  

Comments

Tu, Lijuan Jan. 29, 2022, 3:11 a.m. UTC | #1
> -----Original Message-----
> From: Dong, JunX <junx.dong@intel.com>
> Sent: 2022年1月28日 14:22
> To: dts@dpdk.org
> Cc: Tu, Lijuan <lijuan.tu@intel.com>; Sun, QingX <qingx.sun@intel.com>; Dong,
> JunX <junx.dong@intel.com>
> Subject: [dts][V1] doc/*: fix some document buld warning info.
> 
> Signed-off-by: Jun Dong <junx.dong@intel.com>

Applied
  

Patch

diff --git a/doc/dts_gsg/quick_start.rst b/doc/dts_gsg/quick_start.rst
index a2dbfa68..e6ef9b95 100644
--- a/doc/dts_gsg/quick_start.rst
+++ b/doc/dts_gsg/quick_start.rst
@@ -176,7 +176,7 @@  execution.cfg
 * test_suites: a list of test suites to be executed
 
 $DTS_CFG_FOLDER/crbs.cfg
-~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. code-block:: console
 
@@ -197,7 +197,7 @@  $DTS_CFG_FOLDER/crbs.cfg
 * tester_passwd: Password of Tester linux account, user name should same as dut_user
 
 $DTS_CFG_FOLDER/ports.cfg
-~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. code-block:: console
 
diff --git a/doc/dts_gsg/usr_guide/trex.rst b/doc/dts_gsg/usr_guide/trex.rst
index 00e15baa..8dfa66bd 100644
--- a/doc/dts_gsg/usr_guide/trex.rst
+++ b/doc/dts_gsg/usr_guide/trex.rst
@@ -168,7 +168,7 @@  Add the performance test suite and set perf=true::
     root@tester:dts#
 
 Configure $DTS_CFG_FOLDER/crbs.cfg
-~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Set the pktgen_group=trex or pktgen_group=TREX, this item is case insensitive::
 
     root@tester:dts# cat $DTS_CFG_FOLDER/crbs.cfg
@@ -186,7 +186,7 @@  Set the pktgen_group=trex or pktgen_group=TREX, this item is case insensitive::
     bypass_core0=True
 
 Configure $DTS_CFG_FOLDER/ports.cfg
-~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 This configuration is just same with PF function test, so if you have completed some functional test,
 you have no need to modify the $DTS_CFG_FOLDER/ports.cfg, just like below::
 
@@ -207,7 +207,7 @@  In addition, it could be configured as below::
 We recommend to use the first format configuration, as it has no need to do modification when we do functional test.
 
 Configure $DTS_CFG_FOLDER/pktgen.cfg
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Fill in the $DTS_CFG_FOLDER/pktgen.cfg with your TREX setting, for the first time, you should set start_trex=yes.
 Set the IP address of the device which you installed TREX into item ‘server=’, it should be the tester IP.
 The configuration should as below::