diff mbox series

[3/3] doc: Add info about 'LTP_' and 'TST_' variable prefixes

Message ID 20240104122308.1158487-4-pvorel@suse.cz
State Accepted
Headers show
Series Cleanup environment variables prefixes | expand

Commit Message

Petr Vorel Jan. 4, 2024, 12:23 p.m. UTC 
Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 doc/User-Guidelines.asciidoc | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

Comments

Avinesh Kumar Jan. 4, 2024, 5:54 p.m. UTC | #1 
Hi,

Reviewed-by: Avinesh Kumar <akumar@suse.de>
for all the patches.

--
Thanks,
Avinesh
diff mbox series

Patch

diff --git a/doc/User-Guidelines.asciidoc b/doc/User-Guidelines.asciidoc
index 63081fdea..9ff9a59e7 100644
--- a/doc/User-Guidelines.asciidoc
+++ b/doc/User-Guidelines.asciidoc
@@ -7,6 +7,10 @@  For running LTP network tests see `testcases/network/README.md`.
 1. Library environment variables
 --------------------------------
 
+Following environment variables are expected to be set by LTP users. Therefore,
+with some exceptions, they have 'LTP_' prefix. Environment variables with 'TST_'
+prefix are used inside LTP shell API and should *not* be set by users.
+
 |==============================================================================
 | 'KCONFIG_PATH'        | The path to the kernel config file, (if not set, it tries
                           the usual paths '/boot/config-RELEASE' or '/proc/config.gz').
@@ -45,7 +49,6 @@  For running LTP network tests see `testcases/network/README.md`.
 | 'LTP_ENABLE_DEBUG'    | Enable debug info (value '1' or 'y').
 |==============================================================================
 
-
 2. Test execution time and timeout
 ----------------------------------