From 9f02fb0b914b52336d04a5e8e25102a828fe6191 Mon Sep 17 00:00:00 2001 From: "jose.lausuch" Date: Wed, 24 Feb 2016 14:15:10 +0100 Subject: Fix Doc errors detected in opnfv-docs-verify and add license Some changes taken from https://gerrit.opnfv.org/gerrit/#/c/10595/1 Change-Id: I39f295841c3a89b24e74b7ee613c9da4b223ccab Signed-off-by: jose.lausuch --- docs/userguide/index.rst | 6 ++++-- docs/userguide/introduction.rst | 3 +++ docs/userguide/runfunctest.rst | 14 ++++++++++---- docs/userguide/troubleshooting.rst | 3 ++- 4 files changed, 19 insertions(+), 7 deletions(-) (limited to 'docs/userguide') diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index 79620789f..dcfca16e0 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -1,9 +1,11 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + ========================= OPNFV FUNCTEST user guide ========================= .. toctree:: - :numbered: :maxdepth: 2 @@ -385,7 +387,7 @@ The URL of this dashboard is TODO LF References ========== -.. _`[1]`: Functest configuration guide URL +.. _`[1]`: http://artifacts.opnfv.org/functest/docs/configguide/#functional-testing-installation .. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html .. _`[3]`: https://rally.readthedocs.org/en/latest/index.html .. _`[4]`: http://events.linuxfoundation.org/sites/events/files/slides/Functest%20in%20Depth_0.pdf diff --git a/docs/userguide/introduction.rst b/docs/userguide/introduction.rst index 4e4d33c2a..b130fe1cf 100644 --- a/docs/userguide/introduction.rst +++ b/docs/userguide/introduction.rst @@ -1,3 +1,6 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + Overview of the functest suites =============================== diff --git a/docs/userguide/runfunctest.rst b/docs/userguide/runfunctest.rst index 364333740..573664acc 100644 --- a/docs/userguide/runfunctest.rst +++ b/docs/userguide/runfunctest.rst @@ -1,6 +1,10 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + Executing the functest suites ============================= + Manual testing -------------- @@ -85,8 +89,10 @@ by editing *test_list.txt* file before executing *run_tests.sh* script. This fil is located in *$repos_dir/functest/testcases/VIM/OpenStack/CI/custom_tests/test_list.txt* Although *run_tests.sh* provides an easy way to run any test, it is possible to -do a direct call to the desired test script. For example:: - python $repos_dir/functest/testcases/vPing/vPing.py -d +do a direct call to the desired test script. For example: + + python $repos_dir/functest/testcases/vPing/vPing.py -d + Automated testing ----------------- @@ -135,8 +141,8 @@ The constraints per test case are defined in the Functest configuration file scenario: 'onos' .... -At the end of the Functest environment creation (prepare_env.sh see `[1]`_), a -file */home/opnfv/functest/conf/testcase-list.txt* is created with the list of +At the end of the Functest environment creation, a file +*/home/opnfv/functest/conf/testcase-list.txt* is created with the list of all the runnable tests. Functest considers the static constraints as regular expressions and compare them with the given scenario name. diff --git a/docs/userguide/troubleshooting.rst b/docs/userguide/troubleshooting.rst index f669025ff..7cea6e0c3 100644 --- a/docs/userguide/troubleshooting.rst +++ b/docs/userguide/troubleshooting.rst @@ -1,3 +1,5 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 Troubleshooting =============== @@ -82,7 +84,6 @@ TODO OpenContrail ^^^^^^^^^^^^ - Feature ------- -- cgit 1.2.3-korg