regression: add --python2 and --python3 to run_regression, if nothing provided, use python2.

hltapi: fix bug of not reducing 4 bytes from produced packets because of fcs.
doc: add trex_client package stl/stf example of running examples :)

1 files changed, 26 insertions, 0 deletions

diff --git a/scripts/automation/trex_control_plane/doc_stl/index.rst b/scripts/automation/trex_control_plane/doc_stl/index.rst
index aa2abd75..8a2fc4b0 100644
--- a/scripts/automation/trex_control_plane/doc_stl/index.rst
+++ b/scripts/automation/trex_control_plane/doc_stl/index.rst
@@ -24,6 +24,32 @@ Un-pack it using command::
 
  tar -xzf trex_client.tar.gz
  
+How to use
+==================
+
+| The client assumes server is running.
+| After un-tarring the client package, you can verify basic tests in examples directory out of the box:
+
+.. code-block:: bash
+
+ cd trex_client/stl/examples
+ python stl_imix.py -s <server address>
+
+You can verify that the traffic was sent and arrives properly if you see something like this:::
+
+ Mapped ports to sides [0, 2] <--> [1, 3]
+ Injecting [0, 2] <--> [1, 3] on total rate of '30%' for 10 seconds
+
+ Packets injected from [0, 2]: 473,856
+ Packets injected from [1, 3]: 473,856
+
+ packets lost from [0, 2] --> [0, 2]:   0 pkts
+ packets lost from [1, 3] --> [1, 3]:   0 pkts
+
+ Test has passed :-)
+
+
+Also, in the stl folder there are directories with profiles that define streams and the console (with which you can easily send the profiles)
 
 How to pyATS
 ==================