Bug 9962 - Suggested additions to the --help output re. -v and -D
Summary: Suggested additions to the --help output re. -v and -D
Status: RESOLVED FIXED
Alias: None
Product: BitBake
Classification: Build System, Metadata & Runtime
Component: bitbake (show other bugs)
Version: 2.3
Hardware: x86 Multiple
: Medium enhancement
Target Milestone: 2.3 M4
Assignee: Diana Thayer
QA Contact:
URL:
Whiteboard:
Depends on:
Blocks:
 
Reported: 2016-07-17 08:14 UTC by ulfalizer
Modified: 2017-04-03 21:32 UTC (History)
8 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Done (doc changes complete)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description ulfalizer 2016-07-17 08:14:52 UTC
-v and -D aren't very well documented at the moment. I suggest changing the following,

       -v, --verbose         Output more log message data to the terminal.
       -D, --debug           Increase the debug level. You can specify this more
                             than once.

, to the following:

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

See https://bugzilla.yoctoproject.org/show_bug.cgi?id=9950 as well, which prompted this ticket.
Comment 1 Scott Rifenbark 2016-07-21 19:23:59 UTC
This should probably not be assigned to me as it is the code that needs changing to produce the help output.  Once the code is changed and I can see it merged into poky, I will update the manual's example output section to match.

Scott
Comment 2 ulfalizer 2016-07-22 07:49:54 UTC
One small self-nit: ${T}/log.do_taskname could be changed to ${T}/log.do_<task> to be consistent with the description for -v.
Comment 3 Scott Rifenbark 2016-09-06 18:53:28 UTC
Triage team... please assign this bug to someone else.  

Thanks, 
Scott
Comment 4 Scott Rifenbark 2016-10-25 20:10:33 UTC
Setting target to 2.3 M2 Just to get the bug off my back.  Someone else needs to own this bug.
Comment 5 Scott Rifenbark 2016-11-08 17:43:18 UTC
Bug Team... this bug should be re-assigned to someone that can change the --help code for BitBake.

Scott
Comment 6 Scott Rifenbark 2017-01-31 16:28:42 UTC
Not my bug - please assign to someone that can change the actual help output.  I am setting to "Wait for Upstream" when the actual code is changed.  Let me know when that happens and I will update the doc.

Scott
Comment 7 Scott Rifenbark 2017-03-20 17:58:17 UTC
Setting to 2.3 M4.  This is not my bug.  Please change it to whoever updates the help output in the code.

Scott
Comment 8 Diana Thayer 2017-03-23 02:30:12 UTC
Hello!

I grabbed this bug after submitting a patch for it. I grep'd for the existing documentation, replaced it, and tried to match surrounding whitespace. I did my best to regard patch submission guidelines and code styleguides, but please let me know if there's anything I can do better in the future!

Diana
Comment 9 brian avery 2017-03-23 14:38:32 UTC
I like this more verbose version. If I'm doing a --help, I'd just as soon have a more detailed version.
Comment 10 Scott Rifenbark 2017-03-27 17:11:35 UTC
Hi, 

So I opened a new shell and did a 'git fetch origin' for poky while in my local repo of poky.  Then, I did a 'bitbake -h' command and the help I am getting is still the short version as output for -v and -D - 

  -v, --verbose         Output more log message data to the terminal.
  -D, --debug           Increase the debug level. You can specify this more
                        than once.

Is the change Diana indicated in Comment 8 in a different poky branch?  How do I see the final version of the help text for -v and -D?  

Thanks, 
Scott
Comment 11 brian avery 2017-03-27 19:41:29 UTC
it hasn't been merged yet. patch is at : https://patchwork.openembedded.org/series/5911/#
Comment 12 Scott Rifenbark 2017-03-27 20:56:44 UTC
Thanks Brian... will the patch be merged in time for 2.3?
Comment 13 Ross Burton 2017-03-31 14:40:49 UTC
Merged in Bitbake 921592026c69287cdb40ffd90944d5944f28e2c3.
Comment 14 Scott Rifenbark 2017-04-03 21:32:26 UTC
Hi, 

The patch for the BitBake manual had an error in it.  It was using the < and > characters, which are illegal in DocBook causing the "make" to not work for the manual.  I have updated the file to use the &lt; and &gt; strings so the manual will compile.

I am marking the doc flag to "done" for this bug.

Thanks, 
Scott