diff options
| author |   Martin Klozik <martinx.klozik@intel.com> | 2017-01-26 15:08:11 +0000 |
|---|---|---|
| committer | Martin Klozik <martinx.klozik@intel.com> | 2017-01-30 10:07:33 +0000 |
| commit | ea4376cb3c89f4e3605d7f48036fd61325a52fcf (patch) | |
| tree | 3b8d2501fbda4136cc5e28dfc4ff39d4b9a14ba5 /docs/design/trafficgen_integration_guide.rst | |
| parent | ba2f894bbcc1d303cf5895512ac7eff0524d9d69 (diff) | |
docs: Remove hyperlinks to docs in artifacts
It is possible to use sphinx cross referencing
feature in case, that only one level of toctree
is used. Thus documentation was reorganized
to utilize just one top level index with toctree.
After that it was possible to use rst native syntax
to create a cross links among vsperf documentation
chapters. As a result only 2 hyperlinks to the
yardstick documentation are version specific.
JIRA: VSPERF-442
Change-Id: I15c2f53922e88765506448de61af4a299f5d53c5
Signed-off-by: Martin Klozik <martinx.klozik@intel.com>
Reviewed-by: Al Morton <acmorton@att.com>
Reviewed-by: Christian Trautman <ctrautma@redhat.com>
Reviewed-by: Bill Michalowski <bmichalo@redhat.com>
Reviewed-by: Antonio Fischetti <antonio.fischetti@intel.com>
Reviewed-by: Sridhar Rao <sridhar.rao@spirent.com>
Reviewed-by: Martin Goldammer <martinx.goldammer@intel.com>
Reviewed-by: Trevor Cooper <trevor.cooper@intel.com>
Diffstat (limited to 'docs/design/trafficgen_integration_guide.rst')
| -rw-r--r-- | docs/design/trafficgen_integration_guide.rst | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/docs/design/trafficgen_integration_guide.rst b/docs/design/trafficgen_integration_guide.rst index 1457052b..382cedcb 100644 --- a/docs/design/trafficgen_integration_guide.rst +++ b/docs/design/trafficgen_integration_guide.rst @@ -11,8 +11,7 @@ Intended Audience This document is intended to aid those who want to integrate new traffic generator into the vsperf code. It is expected, that reader has already -read generic part of `VSPERF Design Document -<http://artifacts.opnfv.org/vswitchperf/docs/design/index.html>`__. +read generic part of :ref:`vsperf-design`. Let us create a sample traffic generator called **sample_tg**, step by step. @@ -132,6 +131,8 @@ Example in **tools/pkt_gen/sample_tg/sample_tg.py** module: def disconnect(self): pass +.. _step-5-supported-traffic-types: + Step 5 - supported traffic types ================================ @@ -192,7 +193,7 @@ functions: which are not listed below. Note: There are parameters specific to testing of tunnelling protocols, - which are discussed in detail at `integration tests userguide`_ + which are discussed in detail at :ref:`integration-tests` userguide. * param **traffic_type**: One of the supported traffic types, e.g. **rfc2544_throughput**, **rfc2544_continuous** @@ -235,5 +236,3 @@ are defined in **ResultsConstants** implemented in Throughput & Continuous and for Back2Back. The same key names should be used by all traffic generator implementations. -.. _integration tests userguide: http://artifacts.opnfv.org/vswitchperf/docs/userguide/integration.html - |