summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--scripts/automation/trex_control_plane/doc_stl/api/client_code.rst2
-rw-r--r--scripts/automation/trex_control_plane/doc_stl/api/field_engine.rst4
-rw-r--r--scripts/automation/trex_control_plane/doc_stl/api/index.rst6
-rw-r--r--scripts/automation/trex_control_plane/doc_stl/api/profile_code.rst4
-rw-r--r--scripts/automation/trex_control_plane/doc_stl/index.rst8
5 files changed, 12 insertions, 12 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 16a00122..8736e98d 100644
--- a/scripts/automation/trex_control_plane/doc_stl/api/client_code.rst
+++ b/scripts/automation/trex_control_plane/doc_stl/api/client_code.rst
@@ -1,5 +1,5 @@
-TRex Client Module
+Client Module
==================
TRex Client is an object to access TRex server. It is per user. Each user can own number of interfaces.
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 95a23ac1..d134b0b9 100644
--- a/scripts/automation/trex_control_plane/doc_stl/api/field_engine.rst
+++ b/scripts/automation/trex_control_plane/doc_stl/api/field_engine.rst
@@ -109,7 +109,7 @@ Field Engine snippet
--------------------
.. code-block:: python
- :caption: Example1
+ :caption: FE Example1
base_pkt = Ether()/IP(src="16.0.0.1",dst="48.0.0.1")/UDP(dport=12,sport=1025)
@@ -133,7 +133,7 @@ Field Engine snippet
.. code-block:: python
- :caption: Example2
+ :caption: FE Example2
#range of source mac-addr
diff --git a/scripts/automation/trex_control_plane/doc_stl/api/index.rst b/scripts/automation/trex_control_plane/doc_stl/api/index.rst
index 6e189114..a3c8ad5a 100644
--- a/scripts/automation/trex_control_plane/doc_stl/api/index.rst
+++ b/scripts/automation/trex_control_plane/doc_stl/api/index.rst
@@ -2,14 +2,14 @@
TRex Stateless API Reference
============================
-**TRex Client: STLClient**
+**Client: STLClient**
.. toctree::
:maxdepth: 4
client_code
-**TRex Traffic profile STLProfile,STLStream**
+**Traffic profile STLProfile,STLStream**
.. toctree::
:maxdepth: 4
@@ -25,7 +25,7 @@ TRex Stateless API Reference
scapy_builder
-**TRex Field Engine**
+**Field Engine**
.. toctree::
:maxdepth: 4
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 b2b23e48..b61f05e4 100644
--- a/scripts/automation/trex_control_plane/doc_stl/api/profile_code.rst
+++ b/scripts/automation/trex_control_plane/doc_stl/api/profile_code.rst
@@ -82,7 +82,7 @@ STLProfile snippet
.. code-block:: python
- :caption: Example1
+ :caption: STLProfile Example1
size = self.fsize - 4; # no FCS
@@ -113,7 +113,7 @@ STLProfile snippet
.. code-block:: python
- :caption: Example2
+ :caption: STLProfile Example2
class STLS1(object):
diff --git a/scripts/automation/trex_control_plane/doc_stl/index.rst b/scripts/automation/trex_control_plane/doc_stl/index.rst
index b8a1a8e5..f8097b59 100644
--- a/scripts/automation/trex_control_plane/doc_stl/index.rst
+++ b/scripts/automation/trex_control_plane/doc_stl/index.rst
@@ -12,15 +12,15 @@ To understand the entirely how the API works and how to set up the server side,
**Use the table of contents below or the menu to your left to navigate through the site**
How to Install
-=============
+===============
.. toctree::
:maxdepth: 2
-* **TODO**
-
+* **TODO** Yaroslav Client zip as self-contain
+
API Reference
-=============
+==============
.. toctree::
:maxdepth: 2