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/configguide/upgrade.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/configguide/upgrade.rst')
-rw-r--r-- | docs/configguide/upgrade.rst | 14 |
1 files changed, 4 insertions, 10 deletions
diff --git a/docs/configguide/upgrade.rst b/docs/configguide/upgrade.rst index 3a970c6a..cf92572c 100644 --- a/docs/configguide/upgrade.rst +++ b/docs/configguide/upgrade.rst @@ -120,9 +120,7 @@ options: In case that any of these options is defined, then configuration must be updated. All paths to the tools are now stored inside ``PATHS`` dictionary. Please -refer to the paths-documentation_ and update your configuration where necessary. - -.. _paths-documentation: http://artifacts.opnfv.org/vswitchperf/docs/index.html#configuration-of-paths-dictionary +refer to the :ref:`paths-documentation` and update your configuration where necessary. Configuration change via CLI ============================ @@ -134,7 +132,7 @@ possible to modify any configuration parameter via CLI or via **Parameters** section of the testcase definition. Old configuration options were obsoleted and it is required to specify configuration parameter name in the same form as it is defined inside configuration file, i.e. in uppercase. Please -refer to the overriding-parameters-documentation_ for additional details. +refer to the :ref:`overriding-parameters-documentation` for additional details. **NOTE:** In case that execution of VSPERF is automated by scripts (e.g. for CI purposes), then these scripts must be checked and updated too. It means, @@ -154,12 +152,9 @@ match to data types of original values from configuration files. In case that ``guest_nic1_name`` or ``guest_nic2_name`` is changed, then new dictionary ``GUEST_NICS`` must be modified accordingly. -Please see guest-configuration_ and ``conf/04_vnf.conf`` for additional +Please see :ref:`configuration-of-guest-options` and ``conf/04_vnf.conf`` for additional details. -.. _overriding-parameters-documentation: http://artifacts.opnfv.org/vswitchperf/docs/index.html#overriding-values-defined-in-configuration-files -.. _guest-configuration: http://artifacts.opnfv.org/vswitchperf/docs/index.html#configuration-of-guest-options - Traffic configuration via CLI ============================= @@ -167,7 +162,7 @@ In previous releases it was possible to modify selected attributes of generated traffic via command line interface. This concept has been enhanced in Danube release and it is now possible to modify all traffic specific options via CLI or by ``TRAFFIC`` dictionary in configuration file. Detailed description -is available at configuration-of-traffic-dictionary_ section of documentation. +is available at :ref:`configuration-of-traffic-dictionary` section of documentation. Please check your automated scripts for VSPERF execution for following CLI parameters and update them according to the documentation: @@ -186,4 +181,3 @@ parameters and update them according to the documentation: stream_type traffic_type -.. _configuration-of-traffic-dictionary: http://artifacts.opnfv.org/vswitchperf/docs/index.html#configuration-of-traffic-dictionary |