diff mbox series

docs/acpi/bits: document BITS_DEBUG environment variable

Message ID 20221203132346.34479-1-ani@anisinha.ca (mailing list archive)
State New, archived
Headers show
Series docs/acpi/bits: document BITS_DEBUG environment variable | expand

Commit Message

Ani Sinha Dec. 3, 2022, 1:23 p.m. UTC
Debug specific actions can be enabled in bios bits acpi tests by passing
BITS_DEBUG in the environment variable while running the test. Document that.

CC: qemu-trivial@nongnu.org
Signed-off-by: Ani Sinha <ani@anisinha.ca>
---
 docs/devel/acpi-bits.rst | 3 +++
 1 file changed, 3 insertions(+)

Comments

Wilfred Mallawa Dec. 4, 2022, 10:09 p.m. UTC | #1
On Sat, 2022-12-03 at 13:23 +0000, Ani Sinha wrote:
> Debug specific actions can be enabled in bios bits acpi tests by
> passing
> BITS_DEBUG in the environment variable while running the test.
> Document that.
> 
> CC: qemu-trivial@nongnu.org
> Signed-off-by: Ani Sinha <ani@anisinha.ca>
> ---
>  docs/devel/acpi-bits.rst | 3 +++
>  1 file changed, 3 insertions(+)
Reviewed-by: Wilfred Mallawa <wilfred.mallawa@wdc.com>
> 
> diff --git a/docs/devel/acpi-bits.rst b/docs/devel/acpi-bits.rst
> index 4a94c7d83d..9eb4b9e666 100644
> --- a/docs/devel/acpi-bits.rst
> +++ b/docs/devel/acpi-bits.rst
> @@ -52,6 +52,9 @@ Under ``tests/avocado/`` as the root we have:
>     for their tests. In order to enable debugging, you can set
> **V=1**
>     environment variable. This enables verbose mode for the test and
> also dumps
>     the entire log from bios bits and more information in case
> failure happens.
> +   You can also set **BITS_DEBUG=1** to turn on debug mode. It will
> enable
> +   verbose logs and also retain the temporary work directory the
> test used for
> +   you to inspect and run the specific commands manually.
>  
>     In order to run this test, please perform the following steps
> from the QEMU
>     build directory:
Ani Sinha Dec. 14, 2022, 3:55 p.m. UTC | #2
On Mon, Dec 5, 2022 at 3:39 AM Wilfred Mallawa <wilfred.mallawa@wdc.com> wrote:
>
> On Sat, 2022-12-03 at 13:23 +0000, Ani Sinha wrote:
> > Debug specific actions can be enabled in bios bits acpi tests by
> > passing
> > BITS_DEBUG in the environment variable while running the test.
> > Document that.
> >
> > CC: qemu-trivial@nongnu.org
> > Signed-off-by: Ani Sinha <ani@anisinha.ca>
> > ---
> >  docs/devel/acpi-bits.rst | 3 +++
> >  1 file changed, 3 insertions(+)
> Reviewed-by: Wilfred Mallawa <wilfred.mallawa@wdc.com>

michael, reminder to queue this for the next PR.

> >
> > diff --git a/docs/devel/acpi-bits.rst b/docs/devel/acpi-bits.rst
> > index 4a94c7d83d..9eb4b9e666 100644
> > --- a/docs/devel/acpi-bits.rst
> > +++ b/docs/devel/acpi-bits.rst
> > @@ -52,6 +52,9 @@ Under ``tests/avocado/`` as the root we have:
> >     for their tests. In order to enable debugging, you can set
> > **V=1**
> >     environment variable. This enables verbose mode for the test and
> > also dumps
> >     the entire log from bios bits and more information in case
> > failure happens.
> > +   You can also set **BITS_DEBUG=1** to turn on debug mode. It will
> > enable
> > +   verbose logs and also retain the temporary work directory the
> > test used for
> > +   you to inspect and run the specific commands manually.
> >
> >     In order to run this test, please perform the following steps
> > from the QEMU
> >     build directory:
>
diff mbox series

Patch

diff --git a/docs/devel/acpi-bits.rst b/docs/devel/acpi-bits.rst
index 4a94c7d83d..9eb4b9e666 100644
--- a/docs/devel/acpi-bits.rst
+++ b/docs/devel/acpi-bits.rst
@@ -52,6 +52,9 @@  Under ``tests/avocado/`` as the root we have:
    for their tests. In order to enable debugging, you can set **V=1**
    environment variable. This enables verbose mode for the test and also dumps
    the entire log from bios bits and more information in case failure happens.
+   You can also set **BITS_DEBUG=1** to turn on debug mode. It will enable
+   verbose logs and also retain the temporary work directory the test used for
+   you to inspect and run the specific commands manually.
 
    In order to run this test, please perform the following steps from the QEMU
    build directory: