aboutsummaryrefslogtreecommitdiff
path: root/doc/User-Guidelines.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/User-Guidelines.asciidoc')
-rw-r--r--doc/User-Guidelines.asciidoc9
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/User-Guidelines.asciidoc b/doc/User-Guidelines.asciidoc
index 8f2418df0..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').
@@ -40,10 +44,11 @@ For running LTP network tests see `testcases/network/README.md`.
| 'TMPDIR' | Base directory for template directory (C: '.needs_tmpdir = 1'
and others, which imply it, shell: 'TST_NEEDS_TMPDIR=1').
Must be an absolute path (default: '/tmp').
-| 'TST_NO_CLEANUP' | Disable running test cleanup (defined in 'TST_CLEANUP').
+| 'LTP_NO_CLEANUP' | Disable running test cleanup (defined in 'TST_CLEANUP').
+ Shell API only.
+| 'LTP_ENABLE_DEBUG' | Enable debug info (value '1' or 'y').
|==============================================================================
-
2. Test execution time and timeout
----------------------------------