diff options
Diffstat (limited to 'resources/libraries')
| -rw-r--r-- | resources/libraries/bash/function/docs.sh | 3 | ||||
| -rw-r--r-- | resources/libraries/python/Constants.py | 33 |
2 files changed, 20 insertions, 16 deletions
diff --git a/resources/libraries/bash/function/docs.sh b/resources/libraries/bash/function/docs.sh index c589416a37..cb3f36d21a 100644 --- a/resources/libraries/bash/function/docs.sh +++ b/resources/libraries/bash/function/docs.sh @@ -89,6 +89,9 @@ function generate_docs () { die "rSync failed!" } + # to remove GPL licence section + find "${WORKING_DIR}/tests/" -type f -exec sed -i '/\*\*\*/,$!d' {} \; + find ${WORKING_DIR}/ -type d -exec echo {} \; -exec touch {}/__init__.py \; python3 gen_rst.py || die "Generate .rst files failed!" diff --git a/resources/libraries/python/Constants.py b/resources/libraries/python/Constants.py index c6c9bcaf05..c14ba31c57 100644 --- a/resources/libraries/python/Constants.py +++ b/resources/libraries/python/Constants.py @@ -428,23 +428,24 @@ class Constants: } PERF_TYPE_TO_SUITE_DOC_VER = { - u"mrr": u'''fication:* In MaxReceivedRate tests TG sends traffic\\ -| ... | at line rate and reports total received packets over trial period.\\''', - u"ndrpdr": u'''ication:* TG finds and reports throughput NDR (Non Drop\\ -| ... | Rate) with zero packet loss tolerance and throughput PDR (Partial Drop\\ -| ... | Rate) with non-zero packet loss tolerance (LT) expressed in percentage\\ -| ... | of packets transmitted. NDR and PDR are discovered for different\\ -| ... | Ethernet L2 frame sizes using MLRsearch library.\\''', - u"soak": u'''fication:* TG sends traffic at dynamically computed\\ -| ... | rate as PLRsearch algorithm gathers data and improves its estimate\\ -| ... | of a rate at which a prescribed small fraction of packets\\ -| ... | would be lost. After set time, the serarch stops\\ -| ... | and the algorithm reports its current estimate.\\''', + u"mrr": u'''fication:** In MaxReceivedRate tests TG sends traffic at \\ +| ... | line rate and reports total received packets over trial period. \\''', + u"ndrpdr": u'''rification:** TG finds and reports throughput NDR (Non \\ +| ... | Drop Rate) with zero packet loss tolerance and throughput PDR \\ +| ... | (Partial Drop Rate) with non-zero packet loss tolerance (LT) \\ +| ... | expressed in percentage of packets transmitted. NDR and PDR are \\ +| ... | discovered for different Ethernet L2 frame sizes using MLRsearch \\ +| ... | library.''', + u"soak": u'''rification:** TG sends traffic at dynamically computed \\ +| ... | rate as PLRsearch algorithm gathers data and improves its estimate \\ +| ... | of a rate at which a prescribed small fraction of packets \\ +| ... | would be lost. After set time, the serarch stops \\ +| ... | and the algorithm reports its current estimate. \\''', } PERF_TYPE_TO_TEMPLATE_DOC_VER = { - u"mrr": u'''Measure MaxReceivedRate for ${frame_size}B frames\\ -| | ... | using burst trials throughput test.\\''', - u"ndrpdr": u"Measure NDR and PDR values using MLRsearch algorithm.\\", - u"soak": u"Estimate critical rate using PLRsearch algorithm.\\", + u"mrr": u'''Measure MaxReceivedRate for ${frame_size}B frames \\ +| | ... | using burst trials throughput test. \\''', + u"ndrpdr": u"Measure NDR and PDR values using MLRsearch algorithm.", + u"soak": u"Estimate critical rate using PLRsearch algorithm. \\", } |