Bug 7938 - wic help is inconsistent
Summary: wic help is inconsistent
Status: VERIFIED FIXED
Alias: None
Product: OE-Core
Classification: Build System, Metadata & Runtime
Component: devtools / tool chain (show other bugs)
Version: unspecified
Hardware: x86 Multiple
: Medium enhancement
Target Milestone: 1.9
Assignee: Ed Bartosh
QA Contact: Daniel Istrate
URL:
Whiteboard:
: 7939 (view as bug list)
Depends on:
Blocks:
 
Reported: 2015-07-01 13:20 UTC by Igor Stoppa
Modified: 2015-09-18 14:07 UTC (History)
3 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Don't know


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Igor Stoppa 2015-07-01 13:20:50 UTC
The help for the wic command states at some point that wic should be invoked as:

usage: wic [--version] [--help] COMMAND [ARGS]

and then, later on, it says:

See 'wic help <COMMAND or HELP TOPIC>' ...


The former way (wic --help ...) doesn't seem to work, while the latter does (wic help ...)
Comment 1 Igor Stoppa 2015-07-01 13:23:38 UTC
*** Bug 7939 has been marked as a duplicate of this bug. ***
Comment 2 Ed Bartosh 2015-07-05 13:59:28 UTC
Looks like you're confusing general usage recommendations(wic [--version] [--help] COMMAND [ARGS]) with recommendations to get help (wic help <COMMAND or HELP TOPIC>). Please, confirm this or elaborate further.
Comment 3 Igor Stoppa 2015-07-06 07:49:24 UTC
According to "wic [--version] [--help] COMMAND [ARGS]"
I should use:

"wic --help COMMAND" 


But according to "wic help <COMMAND or HELP TOPIC>"
I should use:

"wic help COMMAND"



This is what I understand from the help page.
What am I confusing?
Comment 4 Ed Bartosh 2015-07-21 10:00:31 UTC
We agreed that usage output should be changed to
usage: wic [[--version] | [--help] | COMMAND [ARGS]

 Current 'wic' commands are:
    help              Show help for one of the topics below
    create            Create a new OpenEmbedded image
    list              List available values for options and image properties

 Help topics:
    overview           wic overview - General overview of wic
    plugins            wic plugins - Overview and API
    kickstart          wic kickstart - wic kickstart reference

Options:
  --version   show program's version number and exit
  -h, --help  show this help message and exit


Igor, please confirm.
Comment 5 Ed Bartosh 2015-08-03 13:56:17 UTC
Submitted fix for review: http://lists.openembedded.org/pipermail/openembedded-core/2015-August/108259.html
Comment 7 Daniel Istrate 2015-09-18 14:07:20 UTC
Verified on master: ea562de57590c966cd5a75fda8defecd397e6436