[LTP] [PATCH 0/2] Improve user variable docs

[LTP] [PATCH 0/2] Improve user variable docs

[Petr Vorel]

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(-)

-- 
2.34.1


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

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

[Petr Vorel]

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 doc/user-guide.txt | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/doc/user-guide.txt b/doc/user-guide.txt
index b1ab13832e..5f5a86c9d0 100644
--- a/doc/user-guide.txt
+++ b/doc/user-guide.txt
@@ -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
-- 
2.34.1


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

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

[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.

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 doc/user-guide.txt | 11 +++--------
 1 file changed, 3 insertions(+), 8 deletions(-)

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.
-- 
2.34.1


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

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

[Li Wang]

For patchset:
Reviewed-by: Li Wang <liwang@redhat.com>

-- 
Regards,
Li Wang


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

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

[Cyril Hrubis]

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>

-- 
Cyril Hrubis
chrubis@suse.cz

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

Re: [LTP] [PATCH 1/2] doc/user-guide: Improve LTPROOT docs

[Cyril Hrubis]

Reviewed-by: Cyril Hrubis <chrubis@suse.cz>

-- 
Cyril Hrubis
chrubis@suse.cz

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

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

[Petr Vorel]

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

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

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

[Petr Vorel]

Hi,

patchset merged with proposed fix.

Kind regards,
Petr

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp