From 25c528e867b13d8ddaee19f208ddedd8a2e505ca Mon Sep 17 00:00:00 2001 From: Dan Klein Date: Tue, 6 Oct 2015 01:54:49 +0300 Subject: removed any T-Rex string in doc --- .../trex_control_plane/doc/about_trex.rst | 21 ++++++++++++--------- .../automation/trex_control_plane/doc/authors.rst | 12 ------------ scripts/automation/trex_control_plane/doc/conf.py | 14 +++++++------- scripts/automation/trex_control_plane/doc/index.rst | 4 +--- .../trex_control_plane/doc/installation.rst | 10 +++++----- .../trex_control_plane/doc/json_dictionary.yaml | 6 +++--- .../automation/trex_control_plane/doc/license.rst | 18 ------------------ .../trex_control_plane/doc/usage_examples.rst | 14 +++++++------- 8 files changed, 35 insertions(+), 64 deletions(-) delete mode 100755 scripts/automation/trex_control_plane/doc/authors.rst delete mode 100755 scripts/automation/trex_control_plane/doc/license.rst diff --git a/scripts/automation/trex_control_plane/doc/about_trex.rst b/scripts/automation/trex_control_plane/doc/about_trex.rst index 97cad97d..669e2b28 100755 --- a/scripts/automation/trex_control_plane/doc/about_trex.rst +++ b/scripts/automation/trex_control_plane/doc/about_trex.rst @@ -1,16 +1,19 @@ -=================== -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 ---------- +GitHub Repository +----------------- -.. toctree:: - :maxdepth: 2 +`TRex GitHub repository `_ + +TRex Google Group +----------------- + +Check out the project's `google group `_ to contact TRex DEV team and follow other user stories. - authors \ No newline at end of file diff --git a/scripts/automation/trex_control_plane/doc/authors.rst b/scripts/automation/trex_control_plane/doc/authors.rst deleted file mode 100755 index 3b85f020..00000000 --- a/scripts/automation/trex_control_plane/doc/authors.rst +++ /dev/null @@ -1,12 +0,0 @@ -======= -Authors -======= - -T-Rex is developed in Cisco Systems Inc. as the next generation traffic generator. - -T-Rex core-team developers are: - - - Hanoch Haim - - Dave Johnson - - Wenxian Li - - Dan Klein \ No newline at end of file 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 ebcd5dcf..10803cb0 100755 --- a/scripts/automation/trex_control_plane/doc/index.rst +++ b/scripts/automation/trex_control_plane/doc/index.rst @@ -51,9 +51,7 @@ About TRex .. toctree:: :maxdepth: 2 - All about T-Rex - license - + All about TRex Indices and tables diff --git a/scripts/automation/trex_control_plane/doc/installation.rst b/scripts/automation/trex_control_plane/doc/installation.rst index dda32f56..f234c260 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 ------------- @@ -14,12 +14,12 @@ Both client and server side were developed for Linux platform. The client-side module is also compatible with windows python. The client side can be used with both Python 2 and Python 3 versions. -However, the server side was desined to and best fits with Python 2.7.6 and on (all 2.x series, assuming > 2.6.9). +However, the server side was designed to and best fits with Python 2.7.6 and on (all 2.x series, assuming > 2.6.9). 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-operation 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 +The full, most updated manual (which refers to all programming languages) can be found under the `trex-core Wiki `_ of the TRex website. \ No newline at end of file diff --git a/scripts/automation/trex_control_plane/doc/json_dictionary.yaml b/scripts/automation/trex_control_plane/doc/json_dictionary.yaml index 853ded65..89535b56 100755 --- a/scripts/automation/trex_control_plane/doc/json_dictionary.yaml +++ b/scripts/automation/trex_control_plane/doc/json_dictionary.yaml @@ -1,6 +1,6 @@ -################################################################ -#### T-Rex JSON Dictionary definitions #### -################################################################ +############################################################### +#### TRex JSON Dictionary definitions #### +############################################################### trex-global : diff --git a/scripts/automation/trex_control_plane/doc/license.rst b/scripts/automation/trex_control_plane/doc/license.rst deleted file mode 100755 index b83dd4b3..00000000 --- a/scripts/automation/trex_control_plane/doc/license.rst +++ /dev/null @@ -1,18 +0,0 @@ -======= -License -======= - - -Copyright 2015 Cisco Systems Inc. - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. 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