By adding support for external build, we extend the
argument documentation for supported options.
Signed-off-by: Tomáš Ďurovec <tomas.duro...@pantheon.tech>
---
doc/guides/tools/dts.rst | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)
diff --git a/doc/guides/tools/dts.rst b/doc/guides/tools/dts.rst
index 65cce9e5ed..20d4d18b18 100644
--- a/doc/guides/tools/dts.rst
+++ b/doc/guides/tools/dts.rst
@@ -236,12 +236,14 @@ DTS is run with ``main.py`` located in the ``dts``
directory after entering Poet
-t SECONDS, --timeout SECONDS
[DTS_TIMEOUT] The default timeout for all DTS
operations except for compiling DPDK. (default: 15)
-v, --verbose [DTS_VERBOSE] Specify to enable verbose output,
logging all messages to the console. (default: False)
- -s, --skip-setup [DTS_SKIP_SETUP] Specify to skip all setup steps on
SUT and TG nodes. (default: False)
+ --dpdk-tree DIR_PATH [DTS_DPDK_TREE] Path to DPDK source code tree to
test. (default: None)
--tarball FILE_PATH, --snapshot FILE_PATH
[DTS_DPDK_TARBALL] Path to DPDK source code tarball
to test. (default: None)
--revision ID, --rev ID, --git-ref ID
[DTS_DPDK_REVISION_ID] Git revision ID to test.
Could be commit, tag, tree ID etc. To test local changes, first
commit them, then use their commit ID. (default:
None)
+ --remote-source [DTS_REMOTE_SOURCE] Set when the DPDK source tree
or tarball is located on the SUT node. (default: False)
+ --build-dir DIR_NAME [DTS_BUILD_DIR] A directory name, which would be
located in the `dpdk tree` or `tarball`. (default: None)
--compile-timeout SECONDS
[DTS_COMPILE_TIMEOUT] The timeout for compiling
DPDK. (default: 1200)
--test-suite TEST_SUITE [TEST_CASES ...]
@@ -257,8 +259,9 @@ DTS is run with ``main.py`` located in the ``dts``
directory after entering Poet
The brackets contain the names of environment variables that set the same
thing.
-The minimum DTS needs is a config file and a DPDK tarball or git ref ID.
-You may pass those to DTS using the command line arguments or use the default
paths.
+The minimum DTS needs is a config file and a pre-built DPDK or DPDK
+sources location which can be specified in said config file or on the
+command line or environment variables.
Example command for running DTS with the template configuration and DPDK tag
v23.11:
--
2.46.1
