diff options
author | John McNamara <john.mcnamara@intel.com> | 2017-05-31 15:34:35 +0100 |
---|---|---|
committer | Marvin Liu <yong.liu@intel.com> | 2017-07-26 21:40:55 +0800 |
commit | 1413f9a3ba21ed1ceaa87f208d502530edcd15d4 (patch) | |
tree | 9486202a842591b1ac400d9d1bc980bdd3580ea5 /test_plans/unit_tests_qos_test_plan.rst | |
parent | 96d22a04406d187d2880749fb4b51c190ec47764 (diff) |
add sphinx docs for the dts test plans
Add sphinx build files to convert the DTS test plans into html
documentation. Fix a number of sphinx/rst warnings and errors.
Signed-off-by: John McNamara <john.mcnamara@intel.com>
Diffstat (limited to 'test_plans/unit_tests_qos_test_plan.rst')
-rw-r--r-- | test_plans/unit_tests_qos_test_plan.rst | 52 |
1 files changed, 26 insertions, 26 deletions
diff --git a/test_plans/unit_tests_qos_test_plan.rst b/test_plans/unit_tests_qos_test_plan.rst index 397c06a..e305cd7 100644 --- a/test_plans/unit_tests_qos_test_plan.rst +++ b/test_plans/unit_tests_qos_test_plan.rst @@ -1,22 +1,22 @@ -.. Copyright (c) <2010>, Intel Corporation +.. Copyright (c) <2010-2017>, Intel Corporation All rights reserved. - + Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - + - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - + - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. - + - Neither the name of Intel Corporation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. - + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS @@ -30,14 +30,14 @@ ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -============ -RED Autotest -============ +======================================== +Unit Tests: Random Early Detection (RED) +======================================== This is the test plan for the Intel® DPDK Random Early Detection feature. -This section explains how to run the unit tests for RED. The test can be launched -independently using the command line interface. +This section explains how to run the unit tests for RED. The test can be launched +independently using the command line interface. This test is implemented as a linuxapp environment application. The complete test suite is launched automatically using a python-expect @@ -46,21 +46,21 @@ the application and checks the results. A test report is displayed on stdout. The steps to run the unit test manually are as follow:: - + # make -C ./app/test/ # ./app/test/test -n 1 -c ffff RTE>> red_autotest The final output of the test has to be "Test OK" - -============== -Meter Autotest -============== + +==================== +Unit Tests: Metering +==================== This is the test plan for the Intel® DPDK Metering feature. -This section explains how to run the unit tests for Meter. The test can be launched -independently using the command line interface. +This section explains how to run the unit tests for Meter. The test can be launched +independently using the command line interface. This test is implemented as a linuxapp environment application. The complete test suite is launched automatically using a python-expect @@ -69,21 +69,21 @@ the application and checks the results. A test report is displayed on stdout. The steps to run the unit test manually are as follow:: - + # make -C ./app/test/ # ./app/test/test -n 1 -c ffff RTE>> meter_autotest The final output of the test has to be "Test OK" -================== -Scheduler Autotest -================== +===================== +Unit tests: Scheduler +===================== This is the test plan for the Intel® DPDK Scheduler feature. -This section explains how to run the unit tests for Scheduler. The test can be -launched independently using the command line interface. +This section explains how to run the unit tests for Scheduler. The test can be +launched independently using the command line interface. This test is implemented as a linuxapp environment application. The complete test suite is launched automatically using a python-expect @@ -92,9 +92,9 @@ the application and checks the results. A test report is displayed on stdout. The steps to run the unit test manually are as follow:: - + # make -C ./app/test/ # ./app/test/test -n 1 -c ffff RTE>> sched_autotest -The final output of the test has to be "Test OK"
\ No newline at end of file +The final output of the test has to be "Test OK" |