[bitbake-devel] [PATCH] bug 9962: improve -v, -D documentation

[Leonardo Sandoval]

On Tue, 2017-03-21 at 13:27 -0700, Diana Thayer wrote:
> Per bug-9962, expanded and clarified documentation
> for -v, --verbose and -D, --debug.
> 
> Signed-off-by: Diana Thayer <garbados at gmail.com>
> ---
>  doc/bitbake-user-manual/bitbake-user-manual-intro.xml | 16 +++++++++++++---
>  lib/bb/main.py                                        | 15 +++++++++++++--
>  2 files changed, 26 insertions(+), 5 deletions(-)
> 
> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-intro.xml b/doc/bitbake-user-manual/bitbake-user-manual-intro.xml
> index 7248a0b..5bbfc67 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-intro.xml
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-intro.xml
> @@ -504,9 +504,19 @@
>                               Read the specified file before bitbake.conf.
>         -R POSTFILE, --postread=POSTFILE
>                               Read the specified file after bitbake.conf.
> -       -v, --verbose         Output more log message data to the terminal.
> -       -D, --debug           Increase the debug level. You can specify this more
> -                             than once.
> +       -v, --verbose         Enable tracing of shell tasks (with 'set -x').
> +                             Also print bb.note(...) messages to stdout (in
> +                             addition to writing them to ${T}/log.do_<task>).
> +       -D, --debug           Increase the debug level. You can specify this
> +                             more than once. -D sets the debug level to 1,
> +                             where only bb.debug(1, ...) messages are printed
> +                             to stdout; -DD sets the debug level to 2, where
> +                             both bb.debug(1, ...) and bb.debug(2, ...)
> +                             messages are printed; etc. Without -D, no debug
> +                             messages are printed. Note that -D only affects
> +                             output to stdout. All debug messages are written
> +                             to ${T}/log.do_taskname, regardless of the debug
> +                             level.

I think the description is fine for -D/--debug , but I am not sure if
this is the place to describe that level N includes N-1, etc.. This is
something standard, and describing here make it a bit verbose.

>         -n, --dry-run         Don't execute, just go through the motions.
>         -S SIGNATURE_HANDLER, --dump-signatures=SIGNATURE_HANDLER
>                               Dump out the signature construction information, with
> diff --git a/lib/bb/main.py b/lib/bb/main.py
> index b3cd2cf..8c948c2 100755
> --- a/lib/bb/main.py
> +++ b/lib/bb/main.py
> @@ -174,10 +174,21 @@ class BitBakeConfigParameters(cookerdata.ConfigParameters):
>                            help="Read the specified file after bitbake.conf.")
>  
>          parser.add_option("-v", "--verbose", action="store_true", dest="verbose", default=False,
> -                          help="Output more log message data to the terminal.")
> +                          help="Enable tracing of shell tasks (with 'set -x'). "
> +                               "Also print bb.note(...) messages to stdout (in "
> +                               "addition to writing them to ${T}/log.do_<task>).")
>  
>          parser.add_option("-D", "--debug", action="count", dest="debug", default=0,
> -                          help="Increase the debug level. You can specify this more than once.")
> +                          help="Increase the debug level. You can specify this "
> +                               "more than once. -D sets the debug level to 1, "
> +                               "where only bb.debug(1, ...) messages are printed "
> +                               "to stdout; -DD sets the debug level to 2, where "
> +                               "both bb.debug(1, ...) and bb.debug(2, ...) "
> +                               "messages are printed; etc. Without -D, no debug "
> +                               "messages are printed. Note that -D only affects "
> +                               "output to stdout. All debug messages are written "
> +                               "to ${T}/log.do_taskname, regardless of the debug "
> +                               "level.")
>  
>          parser.add_option("-q", "--quiet", action="count", dest="quiet", default=0,
>                            help="Output less log message data to the terminal. You can specify this more than once.")
> -- 
> 2.7.4
>