diff options
author | Ana C <ana.cunha@ericsson.com> | 2015-12-11 15:56:08 +0100 |
---|---|---|
committer | Ana C <ana.cunha@ericsson.com> | 2015-12-16 12:18:59 +0100 |
commit | 3f78f83f984553f775f63caaff32dc3c48efff1e (patch) | |
tree | 32e46ea8ce38fc49ce48c8bc85d875f1d2e79d06 /docs/yardstick/opnfv_yardstick_tc012.rst | |
parent | 05c1840c9c4dda154c9c5d00ff3cd23ba202330b (diff) |
Adapt documentation to latest guidelines
Adapt Yardstick documentation according to the latest guidelines from the
Releng project.
The only change in test case description TC001 and TC002 is to remove logo.
The same for the test case description v2 template.
The previous version of test case description is deleted from repo.
The Yardstick_task_template is edited to keep line lenght 80 char.
This commit also adds index for docs/yardstick and for
docs/user_guides/framework.
The overview for the vTC .rst file has been fixed to enable the .pdf
generation.
Change-Id: Ib6480c3c29ce0f0ee22c9ad717439f6a293ab842
Signed-off-by: Ana C <ana.cunha@ericsson.com>
Diffstat (limited to 'docs/yardstick/opnfv_yardstick_tc012.rst')
-rw-r--r-- | docs/yardstick/opnfv_yardstick_tc012.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/yardstick/opnfv_yardstick_tc012.rst b/docs/yardstick/opnfv_yardstick_tc012.rst index 0c8e9c02a..b5768c0c5 100644 --- a/docs/yardstick/opnfv_yardstick_tc012.rst +++ b/docs/yardstick/opnfv_yardstick_tc012.rst @@ -1,4 +1,3 @@ - ************************************* Yardstick Test Case Description TC012 ************************************* @@ -15,7 +14,7 @@ Yardstick Test Case Description TC012 +--------------+--------------------------------------------------------------+ |configuration | File: opnfv_yardstick_tc012.yaml | | | | -| | * SLA (optional): 15000 (MBps) | +| | * SLA (optional): 15000 (MBps) | | | min_bw: The minimum amount of memory bandwidth that is | | | accepted. | | | * Size: 10 240 kB - test allocates twice that size (20 480kB)| @@ -41,8 +40,8 @@ Yardstick Test Case Description TC012 |references | * http://manpages.ubuntu.com/manpages/trusty/bw_mem.8.html | | | | | | * McVoy, Larry W., and Carl Staelin. "lmbench: Portable Tools| -| | for Performance Analysis." *USENIX annual technical | -| | conference*. 1996. | +| | for Performance Analysis." | +| | * USENIX annual technical conference. 1996. | +--------------+--------------------------------------------------------------+ |applicability | Test can be configured with different | | | * memory sizes; | @@ -50,6 +49,7 @@ Yardstick Test Case Description TC012 | | fcp, bzero, bcopy); | | | * number of warmup iterations; | | | * iterations and intervals. | +| | | | | There are default values for each above-mentioned option. | +--------------+--------------------------------------------------------------+ |pre-test | The test case image needs to be installed into Glance | |