aboutsummaryrefslogtreecommitdiffstats
path: root/docs/report/introduction/methodology_autogen.rst
diff options
context:
space:
mode:
authorVratko Polak <vrpolak@cisco.com>2022-10-17 15:08:16 +0200
committerTibor Frank <tifrank@cisco.com>2022-10-18 08:13:26 +0000
commit6809aeefd0f2b951cd4861f676ee2dff0df47ff2 (patch)
treec0edacd0afcb31262f99701e67f0a600a4e07da1 /docs/report/introduction/methodology_autogen.rst
parent4b246a2bf50fd42ec3343dc317e7828d8b0d82da (diff)
fix(report): unify .rst section marks
Unify characters marking section levels, (at least for methodology Vratko contributed to): Level 0: ==== Do not use, or use for index.rst only. (Because git conflicts also create ====.) Level 1: ^^^^ Level 2: ~~~~ Level 3: ```` Level 4: ____ Level 5: ---- Do not use. (Because other documents use this as level 0, and it also appears in tables.) Change-Id: I10813f718b2ee34d1e34c58e62e88353000340e9 Signed-off-by: Vratko Polak <vrpolak@cisco.com>
Diffstat (limited to 'docs/report/introduction/methodology_autogen.rst')
-rw-r--r--docs/report/introduction/methodology_autogen.rst14
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/report/introduction/methodology_autogen.rst b/docs/report/introduction/methodology_autogen.rst
index 1bf5e9e5ea..5453775b7a 100644
--- a/docs/report/introduction/methodology_autogen.rst
+++ b/docs/report/introduction/methodology_autogen.rst
@@ -23,7 +23,7 @@ The generated suites (and their contents) are affected by multiple information
sources, listed below.
Git Suites
-----------
+``````````
The suites present in git repository act as templates for generating suites.
One of autogen design principles is that any template suite should also act
@@ -33,7 +33,7 @@ In practice, autogen always re-creates the template suite with exactly
the same content, it is one of checks that autogen works correctly.
Regenerate Script
------------------
+`````````````````
Not all suites present in CSIT git repository act as template for autogen.
The distinction is on per-directory level. Directories with
@@ -44,13 +44,13 @@ The script also specifies minimal frame size, indirectly, by specifying protocol
(protocol "ip4" is the default, leading to 64B frame size).
Constants
----------
+`````````
Values in Constants.py are taken into consideration when generating suites.
The values are mostly related to different NIC models and NIC drivers.
Python Code
------------
+```````````
Python code in resources/libraries/python/autogen contains several other
information sources.
@@ -89,7 +89,7 @@ Some information sources are available in CSIT repository,
but do not affect the suites generated by autogen.
Testbeds
---------
+````````
Overall, no information visible in topology yaml files is taken into account
by autogen.
@@ -121,7 +121,7 @@ Autogen does not care, as suites are agnostic.
Robot tag marks the difference, but the link presence is not explicitly checked.
Job specs
----------
+`````````
Information in job spec files depend on generated suites (not the other way).
Autogen should generate more suites, as job spec is limited by time budget.
@@ -129,7 +129,7 @@ More suites should be available for manually triggered verify jobs,
so autogen covers that.
Bootstrap Scripts
------------------
+`````````````````
Historically, bootstrap scripts perform some logic,
perhaps adding exclusion options to Robot invocation