diff mbox series

[1/1] doc/user-guide: LTP_RUNTIME_MUL is only for C API

Message ID 20220912101948.4425-1-pvorel@suse.cz
State Changes Requested
Headers show
Series [1/1] doc/user-guide: LTP_RUNTIME_MUL is only for C API | expand

Commit Message

Petr Vorel Sept. 12, 2022, 10:19 a.m. UTC
Not yet implemented in shell API.
+ fix indent.

Fixes: 0f72d519a ("Introduce a concept of max runtime")

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

Comments

Cyril Hrubis Sept. 12, 2022, 1:37 p.m. UTC | #1
Hi!
> Not yet implemented in shell API.
> + fix indent.
> 
> Fixes: 0f72d519a ("Introduce a concept of max runtime")

Should we rather then add "Not yet implemented" instead of "only for C
API" to the actual documentation too?

> Signed-off-by: Petr Vorel <pvorel@suse.cz>
> ---
>  doc/user-guide.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/user-guide.txt b/doc/user-guide.txt
> index 0dc0c958e..fdd74ca41 100644
> --- a/doc/user-guide.txt
> +++ b/doc/user-guide.txt
> @@ -27,8 +27,8 @@ For running LTP network tests see `testcases/network/README.md`.
>                            Variable is also used in shell tests, but ceiled to int.
>  | 'LTP_RUNTIME_MUL'     | Multiplies maximal test iteration runtime. Tests
>                            that run for more than a second or two are capped on
> -			  runtime. You can scale the default runtime both up
> -			  and down with this multiplier.
> +                          runtime. You can scale the default runtime both up
> +                          and down with this multiplier. NOTE: only for C API.
>  | 'LTP_VIRT_OVERRIDE'   | Overrides virtual machine detection in the test
>                            library. Setting it to empty string tell the library
>                            that system is not a virtual machine. Other possible
> -- 
> 2.37.3
>
Petr Vorel Sept. 12, 2022, 8:11 p.m. UTC | #2
> Hi!
> > Not yet implemented in shell API.
> > + fix indent.

> > Fixes: 0f72d519a ("Introduce a concept of max runtime")

> Should we rather then add "Not yet implemented" instead of "only for C
> API" to the actual documentation too?
Sure, no problem.

Kind regards,
Petr

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

> > diff --git a/doc/user-guide.txt b/doc/user-guide.txt
> > index 0dc0c958e..fdd74ca41 100644
> > --- a/doc/user-guide.txt
> > +++ b/doc/user-guide.txt
> > @@ -27,8 +27,8 @@ For running LTP network tests see `testcases/network/README.md`.
> >                            Variable is also used in shell tests, but ceiled to int.
> >  | 'LTP_RUNTIME_MUL'     | Multiplies maximal test iteration runtime. Tests
> >                            that run for more than a second or two are capped on
> > -			  runtime. You can scale the default runtime both up
> > -			  and down with this multiplier.
> > +                          runtime. You can scale the default runtime both up
> > +                          and down with this multiplier. NOTE: only for C API.
> >  | 'LTP_VIRT_OVERRIDE'   | Overrides virtual machine detection in the test
> >                            library. Setting it to empty string tell the library
> >                            that system is not a virtual machine. Other possible
> > -- 
> > 2.37.3
diff mbox series

Patch

diff --git a/doc/user-guide.txt b/doc/user-guide.txt
index 0dc0c958e..fdd74ca41 100644
--- a/doc/user-guide.txt
+++ b/doc/user-guide.txt
@@ -27,8 +27,8 @@  For running LTP network tests see `testcases/network/README.md`.
                           Variable is also used in shell tests, but ceiled to int.
 | 'LTP_RUNTIME_MUL'     | Multiplies maximal test iteration runtime. Tests
                           that run for more than a second or two are capped on
-			  runtime. You can scale the default runtime both up
-			  and down with this multiplier.
+                          runtime. You can scale the default runtime both up
+                          and down with this multiplier. NOTE: only for C API.
 | 'LTP_VIRT_OVERRIDE'   | Overrides virtual machine detection in the test
                           library. Setting it to empty string tell the library
                           that system is not a virtual machine. Other possible