From 92088b136c515a4ca3036a91e5d59a6cac89b60d Mon Sep 17 00:00:00 2001 From: Jan Richter Date: Thu, 14 Dec 2023 15:15:59 +0100 Subject: [PATCH] Better description of Environment Variables in doc This commit adds links to test API, which describes the functionality of `Test.basedir` and `Test.workdir`. This change will help users to better understand what are these variables for. Reference: #5639 Signed-off-by: Jan Richter --- docs/source/guides/writer/chapters/writing.rst | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/source/guides/writer/chapters/writing.rst b/docs/source/guides/writer/chapters/writing.rst index b070e8c58b..ee112a0d81 100644 --- a/docs/source/guides/writer/chapters/writing.rst +++ b/docs/source/guides/writer/chapters/writing.rst @@ -1315,9 +1315,11 @@ tests: +=============================+=======================================+=====================================================================================================+ | AVOCADO_VERSION | Version of Avocado test runner | 92.0 | +-----------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------+ -| AVOCADO_TEST_BASEDIR | Base directory of Avocado tests | $HOME/src/avocado/avocado.dev/examples/tests | +| AVOCADO_TEST_BASEDIR | Base directory of Avocado tests. More | $HOME/src/avocado/avocado.dev/examples/tests | +| | info in :data:`avocado.Test.basedir` | | +-----------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------+ -| AVOCADO_TEST_WORKDIR | Work directory for the test | /var/tmp/.avocado-taskcx8of8di/test-results/tmp_dirfgqrnbu/1-Env.test | +| AVOCADO_TEST_WORKDIR | Work directory for the test. More | /var/tmp/.avocado-taskcx8of8di/test-results/tmp_dirfgqrnbu/1-Env.test | +| | info in :data:`avocado.Test.workdir` | | +-----------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------+ | AVOCADO_TESTS_COMMON_TMPDIR | Temporary directory created by the | /var/tmp/avocado_cp07qzd9 | | | :ref:`plugin_teststmpdir` plugin. The| | @@ -1341,9 +1343,11 @@ tests: +=============================+=======================================+=====================================================================================================+ | AVOCADO_VERSION | Version of Avocado test runner | 92.0 | +-----------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------+ -| AVOCADO_TEST_BASEDIR | Base directory of Avocado tests | $HOME/src/avocado/avocado.dev/examples/tests | +| AVOCADO_TEST_BASEDIR | Base directory of Avocado tests. More | $HOME/src/avocado/avocado.dev/examples/tests | +| | info in :data:`avocado.Test.basedir` | | +-----------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------+ -| AVOCADO_TEST_WORKDIR | Work directory for the test | /var/tmp/.avocado-taskcx8of8di/test-results/tmp_dirfgqrnbu/1-Env.test | +| AVOCADO_TEST_WORKDIR | Work directory for the test. More | /var/tmp/.avocado-taskcx8of8di/test-results/tmp_dirfgqrnbu/1-Env.test | +| | info in :data:`avocado.Test.workdir` | | +-----------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------+ | AVOCADO_TESTS_COMMON_TMPDIR | Temporary directory created by the | /var/tmp/avocado_XhEdo/ | | | :ref:`plugin_teststmpdir` plugin. The| |