From ca479ac9bb1e4d1a5953e9d121ab39a29f7b8b8e Mon Sep 17 00:00:00 2001 From: Dan Klein Date: Thu, 1 Oct 2015 09:15:22 +0300 Subject: Updated control plain documentation with typos and T-Rex changed to TRex. --- scripts/automation/trex_control_plane/doc/about_trex.rst | 8 ++++---- scripts/automation/trex_control_plane/doc/api/index.rst | 6 +++--- .../trex_control_plane/doc/api/json_fields.rst | 12 ++++++------ scripts/automation/trex_control_plane/doc/authors.rst | 7 ++++--- .../automation/trex_control_plane/doc/client_utils.rst | 4 ++-- scripts/automation/trex_control_plane/doc/conf.py | 14 +++++++------- scripts/automation/trex_control_plane/doc/index.rst | 16 ++++++++-------- .../automation/trex_control_plane/doc/installation.rst | 6 +++--- .../automation/trex_control_plane/doc/usage_examples.rst | 14 +++++++------- 9 files changed, 44 insertions(+), 43 deletions(-) (limited to 'scripts/automation/trex_control_plane/doc') diff --git a/scripts/automation/trex_control_plane/doc/about_trex.rst b/scripts/automation/trex_control_plane/doc/about_trex.rst index 97cad97d..08858048 100755 --- a/scripts/automation/trex_control_plane/doc/about_trex.rst +++ b/scripts/automation/trex_control_plane/doc/about_trex.rst @@ -1,11 +1,11 @@ -=================== -About T-Rex project -=================== +================== +About TRex project +================== Full project's official site ---------------------------- -To learn all about T-Rex project, visit Cisco's internal `official site `_ +To learn all about TRex project, visit TRex `official site `_ Even more --------- diff --git a/scripts/automation/trex_control_plane/doc/api/index.rst b/scripts/automation/trex_control_plane/doc/api/index.rst index 8233a634..7c558a94 100755 --- a/scripts/automation/trex_control_plane/doc/api/index.rst +++ b/scripts/automation/trex_control_plane/doc/api/index.rst @@ -1,9 +1,9 @@ API Reference ============= -The T-Rex API reference section is currently a work in progress. +The TRex API reference section is currently a work in progress. -**T-Rex Modules** +**TRex Modules** .. toctree:: :maxdepth: 4 @@ -11,7 +11,7 @@ The T-Rex API reference section is currently a work in progress. client_code exceptions -**T-Rex JSON Template** +**TRex JSON Template** .. toctree:: :maxdepth: 4 diff --git a/scripts/automation/trex_control_plane/doc/api/json_fields.rst b/scripts/automation/trex_control_plane/doc/api/json_fields.rst index b1a2af7c..193aa01b 100755 --- a/scripts/automation/trex_control_plane/doc/api/json_fields.rst +++ b/scripts/automation/trex_control_plane/doc/api/json_fields.rst @@ -1,23 +1,23 @@ -T-Rex JSON Template -=================== +TRex JSON Template +================== -Whenever T-Rex is publishing live data, it uses JSON notation to describe the data-object. +Whenever TRex is publishing live data, it uses JSON notation to describe the data-object. -Each client may parse it diffrently, however this page will describe the values meaning when published by T-Rex server. +Each client may parse it diffrently, however this page will describe the values meaning when published by TRex server. Main Fields ----------- -Each T-Rex server-published JSON object contains data divided to main fields under which the actual data lays. +Each TRex server-published JSON object contains data divided to main fields under which the actual data lays. These main fields are: +-----------------------------+----------------------------------------------------+---------------------------+ | Main field | Contains | Comments | +=============================+====================================================+===========================+ -| :ref:`trex-global-field` | Must-have data on T-Rex run, | | +| :ref:`trex-global-field` | Must-have data on TRex run, | | | | mainly regarding Tx/Rx and packet drops | | +-----------------------------+----------------------------------------------------+---------------------------+ | :ref:`tx-gen-field` | Data indicate the quality of the transmit process. | | diff --git a/scripts/automation/trex_control_plane/doc/authors.rst b/scripts/automation/trex_control_plane/doc/authors.rst index 3b85f020..08ee5db5 100755 --- a/scripts/automation/trex_control_plane/doc/authors.rst +++ b/scripts/automation/trex_control_plane/doc/authors.rst @@ -2,11 +2,12 @@ Authors ======= -T-Rex is developed in Cisco Systems Inc. as the next generation traffic generator. +TRex is developed in Cisco Systems Inc. as the next generation traffic generator. -T-Rex core-team developers are: +TRex core-team developers are: - Hanoch Haim - Dave Johnson - Wenxian Li - - Dan Klein \ No newline at end of file + - Dan Klein + - Itay Marom \ No newline at end of file diff --git a/scripts/automation/trex_control_plane/doc/client_utils.rst b/scripts/automation/trex_control_plane/doc/client_utils.rst index 224dfe19..5f133eee 100755 --- a/scripts/automation/trex_control_plane/doc/client_utils.rst +++ b/scripts/automation/trex_control_plane/doc/client_utils.rst @@ -2,8 +2,8 @@ Client Utilities ================ -T-Rex YAML generator --------------------- +TRex YAML generator +------------------- .. automodule:: trex_yaml_gen :members: diff --git a/scripts/automation/trex_control_plane/doc/conf.py b/scripts/automation/trex_control_plane/doc/conf.py index fb9ea83c..46d0435d 100755 --- a/scripts/automation/trex_control_plane/doc/conf.py +++ b/scripts/automation/trex_control_plane/doc/conf.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- # -# T-Rex Control Plain documentation build configuration file, created by +# TRex Control Plain documentation build configuration file, created by # sphinx-quickstart on Tue Jun 2 07:48:10 2015. # # This file is execfile()d with the current directory set to its @@ -54,7 +54,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'T-Rex Control Plain' +project = u'TRex Control Plain' copyright = u'2015, Cisco Systems Inc.' author = u'Dan Klein for Cisco Systems Inc.' @@ -211,7 +211,7 @@ html_static_path = ['_static'] #html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = 'T-RexControlPlaindoc' +htmlhelp_basename = 'TRexControlPlaindoc' # -- Options for LaTeX output --------------------------------------------- @@ -233,7 +233,7 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'T-RexControlPlain.tex', u'T-Rex Control Plain Documentation', + (master_doc, 'TRexControlPlain.tex', u'TRex Control Plain Documentation', u'Dan Klein for Cisco Systems Inc', 'manual'), ] @@ -263,7 +263,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 't-rexcontrolplain', u'T-Rex Control Plain Documentation', + (master_doc, 'TRexcontrolplain', u'TRex Control Plain Documentation', [author], 1) ] @@ -277,8 +277,8 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'T-RexControlPlain', u'T-Rex Control Plain Documentation', - author, 'T-RexControlPlain', 'One line description of project.', + (master_doc, 'TRexControlPlain', u'TRex Control Plain Documentation', + author, 'TRexControlPlain', 'One line description of project.', 'Miscellaneous'), ] diff --git a/scripts/automation/trex_control_plane/doc/index.rst b/scripts/automation/trex_control_plane/doc/index.rst index e7a619d8..dcaf9505 100755 --- a/scripts/automation/trex_control_plane/doc/index.rst +++ b/scripts/automation/trex_control_plane/doc/index.rst @@ -1,18 +1,18 @@ -.. T-Rex Control Plain documentation master file, created by +.. TRex Control Plain documentation master file, created by sphinx-quickstart on Tue Jun 2 07:48:10 2015. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to T-Rex Control Plain's documentation! +Welcome to TRex Control Plain's documentation! =============================================== -T-Rex is a **realistic traffic generator** that enables you to do get learn more about your under developement devices. +TRex is a **realistic traffic generator** that enables you to do get learn more about your under developement devices. -This site covers the Python API of T-Rex control plane, and explains how to utilize it to your needs. +This site covers the Python API of TRex control plane, and explains how to utilize it to your needs. However, since the entire API is JSON-RPC [#f1]_ based, you may want to check out other implementations that could suit you. -To understand the entirely how the API works and how to set up the server side, check out the `API documentation `_ undee the documentation section of T-Rex website. +To understand the entirely how the API works and how to set up the server side, check out the `API documentation `_ undee the documentation section of TRex website. **Use the table of contents below or the menu to your left to navigate through the site** @@ -34,12 +34,12 @@ API Reference api/index -About T-Rex -=========== +About TRex +========== .. toctree:: :maxdepth: 2 - All about T-Rex + All about TRex license diff --git a/scripts/automation/trex_control_plane/doc/installation.rst b/scripts/automation/trex_control_plane/doc/installation.rst index dda32f56..29239d97 100755 --- a/scripts/automation/trex_control_plane/doc/installation.rst +++ b/scripts/automation/trex_control_plane/doc/installation.rst @@ -4,9 +4,9 @@ Installation Prerequisites ------------- -The T-Rex control plane is based on client-server model that interacts using JSON-RPC. +The TRex control plane is based on client-server model that interacts using JSON-RPC. -In order to use the client-side API documented a T-Rex server daemon must be up and listening on the same host and port that the client tries to connect with. +In order to use the client-side API documented a TRex server daemon must be up and listening on the same host and port that the client tries to connect with. Compatibility ------------- @@ -20,6 +20,6 @@ However, the server side was desined to and best fits with Python 2.7.6 and on ( Installation manual ------------------- -T-Rex Control Plane is a cross-platform, cross-operatin system APi to control and run T-Rex. +TRex Control Plane is a cross-platform, cross-operating system APi to control and run TRex. The full, most updated manual (which refers to all programming languages) can be found under the `Automation API documentation `_ . \ No newline at end of file diff --git a/scripts/automation/trex_control_plane/doc/usage_examples.rst b/scripts/automation/trex_control_plane/doc/usage_examples.rst index 7116f28c..ff5c026d 100755 --- a/scripts/automation/trex_control_plane/doc/usage_examples.rst +++ b/scripts/automation/trex_control_plane/doc/usage_examples.rst @@ -6,7 +6,7 @@ Usage Examples Full-featured interactive shell ------------------------------- -The `client_interactive_example.py` extends and uses the `Cmd `_ built in python class to create a Full-featured shell using which one can interact with T-Rex server and get instant results. +The `client_interactive_example.py` extends and uses the `Cmd `_ built in python class to create a Full-featured shell using which one can interact with TRex server and get instant results. The help menu of this application is: @@ -14,21 +14,21 @@ The help menu of this application is: usage: client_interactive_example [options] - Run T-Rex client API demos and scenarios. + Run TRex client API demos and scenarios. optional arguments: -h, --help show this help message and exit -v, --version show program's version number and exit -t HOST, --trex-host HOST - Specify the hostname or ip to connect with T-Rex + Specify the hostname or ip to connect with TRex server. -p PORT, --trex-port PORT - Select port on which the T-Rex server listens. Default + Select port on which the TRex server listens. Default port is 8090. -m SIZE, --maxhist SIZE Specify maximum history size saved at client side. Default size is 100. - --verbose Switch ON verbose option at T-Rex client. Default is: + --verbose Switch ON verbose option at TRex client. Default is: OFF. **Code Excerpt** @@ -51,8 +51,8 @@ The demo takes the user a full circle: 2. exporting the generated packets into .pcap file named `dns_traffic.pcap`. 3. Use the :class:`trex_yaml_gen.CTRexYaml` generator to include that pcap file in the yaml object. 4. Export the YAML object onto a YAML file named `dns_traffic.yaml` - 5. Push the generated files to T-Rex server. - 6. Run T-Rex based on the generated (and pushed) files. + 5. Push the generated files to TRex server. + 6. Run TRex based on the generated (and pushed) files. **Code Excerpt** [#f1]_ -- cgit 1.2.3-korg