Skip to contentSkip to conversation

Improve user variable docs

PATCH In review Petr Vorel 3 participants 8 messages Jan 14, 2022 – Jan 24, 2022

lore
Share & tools
lore

Petr Vorel

author
#0 lore raw

cover Improve user variable docs

Hi,

some improvements + test for fixing wiki mirror :).

Kind regards,
Petr

Petr Vorel (2):
doc/user-guide: Improve LTPROOT docs doc/user-guide: Remove "2. Colorized output" section

 doc/user-guide.txt | 15 ++++++---------
 1 file changed, 6 insertions(+), 9 deletions(-)
Signature · 5 lines
2.34.1


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
author
#1 lore raw

PATCH 1/2 doc/user-guide: Improve LTPROOT docs

---
 doc/user-guide.txt | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
doc/user-guide.txt +3 -1
index b1ab13832e..5f5a86c9d0 100644
@@ -11,7 +11,9 @@ For running LTP network tests see `testcases/network/README.md`.
 | 'KCONFIG_PATH'        | The path to the kernel config file, (if not set, it tries
                           the usual paths '/boot/config-RELEASE' or '/proc/config.gz').
 | 'KCONFIG_SKIP_CHECK'  | Skip kernel config check if variable set (not set by default).
-| 'LTPROOT'             | Prefix for installed LTP, the default is '/opt/ltp'.
+| 'LTPROOT'             | Prefix for installed LTP.  **Should be always set**
+                          as some tests need it for path to test data files
+                          ('LTP_DATAROOT'). LTP is by default installed into '/opt/ltp'.
 | 'LTP_COLORIZE_OUTPUT' | Force colorized output behaviour. 'y' or '1': always colorize
                           'n' or '0': never colorize.
 | 'LTP_DEV'             | Path to the block device to be used
Signature · 5 lines
2.34.1


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
author
#3 lore raw

PATCH 2/2 doc/user-guide: Remove "2. Colorized output" section

In reply to Petr Vorel

There are move important topics in the variables,
but only colors have it's own section.

Although it might be easier to find particular functionality though these sections, let's keep just single table.

---
 doc/user-guide.txt | 11 +++--------
 1 file changed, 3 insertions(+), 8 deletions(-)
doc/user-guide.txt +3 -8
index 5f5a86c9d0..9eff725585 100644
@@ -14,8 +14,9 @@ For running LTP network tests see `testcases/network/README.md`.
 | 'LTPROOT'             | Prefix for installed LTP.  **Should be always set**
                           as some tests need it for path to test data files
                           ('LTP_DATAROOT'). LTP is by default installed into '/opt/ltp'.
-| 'LTP_COLORIZE_OUTPUT' | Force colorized output behaviour. 'y' or '1': always colorize
-                          'n' or '0': never colorize.
+| 'LTP_COLORIZE_OUTPUT' | By default LTP colorizes it's output unless using
+                          pipe or redirect to file.  Force colorized output behaviour:
+                          'y' or '1': always colorize, 'n' or '0': never colorize.
 | 'LTP_DEV'             | Path to the block device to be used
                           (C: '.needs_device = 1', shell: 'TST_NEEDS_DEVICE=1').
 | 'LTP_SINGLE_FS_TYPE'  | Testing only - specifies filesystem instead all
@@ -35,9 +36,3 @@ For running LTP network tests see `testcases/network/README.md`.
                           and others, which imply it, shell: 'TST_NEEDS_TMPDIR=1').
 | 'TST_NO_CLEANUP'      | Disable running test cleanup (defined in 'TST_CLEANUP').
 |==============================================================================
-
-2. Colorized output
--------------------
-
-By default LTP colorizes it's output unless using pipe or redirect to file.
-It's possible to force behaviour with 'LTP_COLORIZE_OUTPUT' environment variable.
Signature · 5 lines
2.34.1


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
Reviewed-by on v1 2/2
#4 lore raw

Re: [LTP] [PATCH 2/2] doc/user-guide: Remove "2. Colorized output" section

For patchset:

Signature · 6 lines
Regards,
Li Wang


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
Reviewed-by on v1 2/2
#5 lore raw

Re: [LTP] [PATCH 2/2] doc/user-guide: Remove "2. Colorized output" section

In reply to Petr Vorel

Hi!

doc/user-guide.txt For running LTP network tests see `testcases/network/README.md`. · line 18

Quoted 8 lines
doc/user-guide.txt +2 -2
@@ -14,8 +14,9 @@ For running LTP network tests see `testcases/network/README.md`.
 | 'LTPROOT'             | Prefix for installed LTP.  **Should be always set**
                           as some tests need it for path to test data files
                           ('LTP_DATAROOT'). LTP is by default installed into '/opt/ltp'.
-| 'LTP_COLORIZE_OUTPUT' | Force colorized output behaviour. 'y' or '1': always colorize
-                          'n' or '0': never colorize.
+| 'LTP_COLORIZE_OUTPUT' | By default LTP colorizes it's output unless using
+                          pipe or redirect to file.  Force colorized output behaviour:

Slightly better: "unless it's redirected to a pipe or file"

Signature · 5 lines
Cyril Hrubis
[email protected]

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
author
#6 lore raw

Re: [LTP] [PATCH 2/2] doc/user-guide: Remove "2. Colorized output" section

Hi Cyril,

Quoted 6 lines

doc/user-guide.txt For running LTP network tests see `testcases/network/README.md`. · line 18

Quoted 4 lines

-| 'LTP_COLORIZE_OUTPUT' | Force colorized output behaviour. 'y' or '1': always colorize

doc/user-guide.txt +2 -1
-                          'n' or '0': never colorize.
+| 'LTP_COLORIZE_OUTPUT' | By default LTP colorizes it's output unless using
+                          pipe or redirect to file.  Force colorized output behaviour:

Slightly better: "unless it's redirected to a pipe or file"

+1, thanks!

Kind regards,
Petr

Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
author
#7 lore raw

Re: [LTP] [PATCH 2/2] doc/user-guide: Remove "2. Colorized output" section

In reply to Cyril Hrubis

Hi,

patchset merged with proposed fix.

Kind regards,
Petr

Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp