summaryrefslogtreecommitdiffstats
path: root/scripts/automation/trex_control_plane/doc_stl
diff options
context:
space:
mode:
authorYaroslav Brustinov <ybrustin@cisco.com>2016-09-13 17:30:14 +0300
committerYaroslav Brustinov <ybrustin@cisco.com>2016-09-13 17:30:14 +0300
commit138686f389fe48139ddc4a57ac5de363e71b38e7 (patch)
tree35cc977a555f80ac64c6aff4bbc045819dd080a5 /scripts/automation/trex_control_plane/doc_stl
parent58f1ee52761a489322036f111793ddd8e85e197a (diff)
dpdk Python scripts small fixes
ensure log dir exists for trex daemon regression: add trex24 setup Sphinx docs remove "capture" tag for compatibility with 1.2 version
Diffstat (limited to 'scripts/automation/trex_control_plane/doc_stl')
-rwxr-xr-xscripts/automation/trex_control_plane/doc_stl/api/client_code.rst12
-rwxr-xr-xscripts/automation/trex_control_plane/doc_stl/api/field_engine.rst6
-rwxr-xr-xscripts/automation/trex_control_plane/doc_stl/api/profile_code.rst6
3 files changed, 16 insertions, 8 deletions
diff --git a/scripts/automation/trex_control_plane/doc_stl/api/client_code.rst b/scripts/automation/trex_control_plane/doc_stl/api/client_code.rst
index 08720e8d..953c5c84 100755
--- a/scripts/automation/trex_control_plane/doc_stl/api/client_code.rst
+++ b/scripts/automation/trex_control_plane/doc_stl/api/client_code.rst
@@ -69,7 +69,8 @@ STLClient snippet
.. code-block:: python
- :caption: Example 1: Minimal example of client interacting with the TRex server
+
+ # Example 1: Minimal example of client interacting with the TRex server
c = STLClient()
@@ -102,7 +103,8 @@ STLClient snippet
.. code-block:: python
- :caption: Example 2: Client can execute other functions while the TRex server is generating traffic
+
+ # Example 2: Client can execute other functions while the TRex server is generating traffic
c = STLClient()
@@ -128,7 +130,8 @@ STLClient snippet
.. code-block:: python
- :caption: Example 3: Console-like API interface
+
+ # Example 3: Console-like API interface
def simple ():
@@ -224,7 +227,8 @@ Example 4: Load profile from a file::
.. code-block:: python
- :caption: Example 5: pin cores to ports
+
+ # Example 5: pin cores to ports
c = STLClient()
diff --git a/scripts/automation/trex_control_plane/doc_stl/api/field_engine.rst b/scripts/automation/trex_control_plane/doc_stl/api/field_engine.rst
index d4f95170..39afa38b 100755
--- a/scripts/automation/trex_control_plane/doc_stl/api/field_engine.rst
+++ b/scripts/automation/trex_control_plane/doc_stl/api/field_engine.rst
@@ -153,7 +153,8 @@ Field Engine snippet
--------------------
.. code-block:: python
- :caption: FE Example1
+
+ # FE Example1
base_pkt = Ether()/IP(src="16.0.0.1",dst="48.0.0.1")/UDP(dport=12,sport=1025)
@@ -177,7 +178,8 @@ Field Engine snippet
.. code-block:: python
- :caption: FE Example2
+
+ # FE Example2
#range of source mac-addr
diff --git a/scripts/automation/trex_control_plane/doc_stl/api/profile_code.rst b/scripts/automation/trex_control_plane/doc_stl/api/profile_code.rst
index 335105f1..8a0d7a2a 100755
--- a/scripts/automation/trex_control_plane/doc_stl/api/profile_code.rst
+++ b/scripts/automation/trex_control_plane/doc_stl/api/profile_code.rst
@@ -88,7 +88,8 @@ STLProfile snippet
.. code-block:: python
- :caption: STLProfile Example1
+
+ # STLProfile Example1
size = self.fsize - 4; # no FCS
@@ -119,7 +120,8 @@ STLProfile snippet
.. code-block:: python
- :caption: STLProfile Example2
+
+ # STLProfile Example2
class STLS1(object):