Update soak results page

+ Link to methodology (instead telling readers to search there).
+ Explain low amount of test results shown.
+ Clarify that y-axis shows an estimated interval (not direct measurement).

Change-Id: I4d9132fa102624a38d52f0e52dd12e834bd1350f
Signed-off-by: Vratko Polak <vrpolak@cisco.com>

diff --git a/docs/report/introduction/methodology_plrsearch.rst b/docs/report/introduction/methodology_plrsearch.rst
index ae0b356..7529aca 100644 (file)
--- a/docs/report/introduction/methodology_plrsearch.rst
+++ b/docs/report/introduction/methodology_plrsearch.rst
@@ -1,4 +1,4 @@
-.. _plrsearch_algorithm:
+.. _`PLRsearch algorithm`:
 
 PLRsearch
 ^^^^^^^^^

diff --git a/docs/report/vpp_performance_tests/soak_tests/index.rst b/docs/report/vpp_performance_tests/soak_tests/index.rst
index 95ff414..568d047 100644 (file)
--- a/docs/report/vpp_performance_tests/soak_tests/index.rst
+++ b/docs/report/vpp_performance_tests/soak_tests/index.rst
@@ -33,8 +33,11 @@
 Soak Tests
 ==========
 
-Long duration soak tests are executed using PLRsearch algorithm. See
-methodology section for PLRsearch description.
+Long duration soak tests are executed using `PLRsearch algorithm`_.
+
+As soak tests are new, and take long time to run,
+only 6 tests were executed. From those, 4 tests encountered some caveat,
+making their results unreliable.
 
 Additional information about graph data:
 
@@ -42,12 +45,12 @@ Additional information about graph data:
 
 #. **X-axis Labels**: indices of test suites.
 
-#. **Y-axis Labels**: measured packet throughput values in [Mpps].
+#. **Y-axis Labels**: estimated intervals for packet throughput value in [Mpps].
 
 #. **Graph Legend**: list of X-axis indices with CSIT test suites.
 
-#. **Hover Information**: lists the lower and upper bounds of measured
-   throughput.
+#. **Hover Information**: lists the lower and upper bounds for the estimated
+   throughput value.
 
 .. note::