FIX: remove previous QEMU build when needed to change qsz

[csit.git] / docs / tag_documentation.rst

diff --git a/docs/tag_documentation.rst b/docs/tag_documentation.rst
index a10ac0e..537bece 100644 (file)
--- a/docs/tag_documentation.rst
+++ b/docs/tag_documentation.rst
@@ -1,8 +1,10 @@
 CSIT TAGs Descriptions
 ======================
 
-Documentation for tags used to select and identify test cases.
-
+All CSIT test cases are labelled with Robot Framework tags used to allow for
+easy test case type identification, test case grouping and selection for
+execution. Following sections list currently used CSIT TAGs and their
+documentation.
 
 Topology TAGs
 -------------
@@ -25,6 +27,9 @@ Objective TAGs
     Test case(s) marked to not run in case of vpp-csit-verify (i.e. VPP patch)
     and csit-vpp-verify jobs (i.e. CSIT patch).
 
+.. topic:: SKIP_VPP_PATCH
+
+    Test case(s) marked to not run in case of vpp-csit-verify (i.e. VPP patch).
 
 Environment TAGs
 ----------------
@@ -41,7 +46,6 @@ Environment TAGs
 
     DUTs with VPP and capable of running Virtual Machine.
 
-
 NIC model tags
 --------------
 
@@ -65,7 +69,6 @@ NIC model tags
 
     VIC-1385 by Cisco.
 
-
 Scaling TAGs
 ------------
 
@@ -105,7 +108,6 @@ Scaling TAGs
 
     Traffic flow with 4000 unique IPs (users) in one direction.
 
-
 Tags marking functional vs. performance of tests
 ------------------------------------------------
 
@@ -117,7 +119,6 @@ Tags marking functional vs. performance of tests
 
     All performance test cases.
 
-
 Performance testing tags
 ------------------------
 
@@ -215,6 +216,9 @@ Test type tags
 
     At least one feature is configured in test cases. Use also feature tag(s).
 
+.. topic:: TLDK
+
+    Functional test cases for TLDK.
 
 Forwarding mode tags
 --------------------
@@ -239,7 +243,6 @@ Forwarding mode tags
 
     VPP IPv6 routed forwarding.
 
-
 Underlay tags
 -------------
 
@@ -255,7 +258,6 @@ Underlay tags
 
     MPLS underlay.
 
-
 Overlay tags
 ------------
 
@@ -271,7 +273,6 @@ Overlay tags
 
     IPv6 overlay (IPv6 payload).
 
-
 Encapsulation tags
 ------------------
 
@@ -311,7 +312,6 @@ Encapsulation tags
 
     All test cases with IPSEC.
 
-
 Interface tags
 --------------
 
@@ -323,6 +323,18 @@ Interface tags
 
     All test cases which uses VHOST.
 
+.. topic:: VHOST_256
+
+    All test cases which uses VHOST with qemu queue size set to 256.
+
+.. topic:: VHOST_1024
+
+    All test cases which uses VHOST with qemu queue size set to 1024.
+
+.. topic:: CFS_OPT
+
+    All test cases which uses VM with optimised scheduler policy.
+
 .. topic:: TUNTAP
 
     All test cases which uses TUN and TAP.
@@ -335,6 +347,9 @@ Interface tags
 
     All test cases which uses Netmap.
 
+.. topic:: MEMIF
+
+    All test cases which uses Memif.
 
 Feature tags
 ------------
@@ -351,7 +366,6 @@ Feature tags
 
     SNAT configured and tested.
 
-
 Encryption tags
 ---------------
 
@@ -371,7 +385,6 @@ Encryption tags
 
     IPSec in tunnel mode.
 
-
 Client-workload tags
 --------------------
 
@@ -387,7 +400,6 @@ Client-workload tags
 
     All test cases with specific APP use.
 
-
 Multi-threading tags
 --------------------
 
@@ -439,3 +451,19 @@ Multi-threading tags
 
     8 worker threads pinned to 8 dedicated physical cores. 4 receive queues per
     interface. Main thread pinned to core 0.
+
+Honeycomb tags
+--------------
+
+.. topic:: HC_FUNC
+
+    Honeycomb functional test cases.
+
+.. topic:: HC_PERSIST
+
+    Honeycomb persistence test cases.
+
+.. topic:: HC_REST_ONLY
+
+    (Exclusion tag) Honeycomb test cases that cannot be run in Netconf mode
+    using ODL client for Restfconf -> Netconf translation.