| Message ID | 20220114194444.16949-3-pvorel@suse.cz |
|---|---|
| State | Accepted |
| Headers | show |
| Series | Improve user variable docs | expand |
For patchset:
Reviewed-by: Li Wang <liwang@redhat.com>
Hi! > @@ -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" Reviewed-by: Cyril Hrubis <chrubis@suse.cz>
Hi Cyril, > > -| '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" +1, thanks! Kind regards, Petr
Hi, patchset merged with proposed fix. Kind regards, Petr
diff --git a/doc/user-guide.txt b/doc/user-guide.txt index 5f5a86c9d0..9eff725585 100644 --- a/doc/user-guide.txt +++ b/doc/user-guide.txt @@ -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.
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. Signed-off-by: Petr Vorel <pvorel@suse.cz> --- doc/user-guide.txt | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-)