Bug 8322 - yocto-bsp create script does not show usage/SYNOPSIS for all supported parameters
Summary: yocto-bsp create script does not show usage/SYNOPSIS for all supported parame...
Status: RESOLVED FIXED
Alias: None
Product: OE-Core
Classification: Build System, Metadata & Runtime
Component: Scripts and Tools (show other bugs)
Version: 2.1
Hardware: x86 Multiple
: Medium normal
Target Milestone: 2.1 M4
Assignee: Humberto Ibarra
QA Contact:
URL:
Whiteboard:
Depends on:
Blocks:
 
Reported: 2015-09-17 19:34 UTC by Leonardo Sandoval Gonzalez
Modified: 2016-03-28 15:11 UTC (History)
2 users (show)

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

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Leonardo Sandoval Gonzalez 2015-09-17 19:34:56 UTC 
When creating a BSP layer with the yocto-bsp script, user can generate a coredump (-c) and skip the git check (-s). These parameters are now reflected on the usage/SYNOPSIS.

In fact, this bug is closely related to https://bugzilla.yoctoproject.org/show_bug.cgi?id=8321, but the current one focus on the command's help.

> yocto-bsp help create | grep SYNOPSIS -A2
SYNOPSIS
    yocto-bsp create <bsp-name> <karch> [-o <DIRNAME> | --outdir <DIRNAME>]
        [-i <JSON PROPERTY FILE> | --infile <JSON PROPERTY_FILE>]

> yocto-bsp create | grep usage -A2
ERROR:root:Wrong number of arguments, exiting

 usage: yocto-bsp create <bsp-name> <karch> [-o <DIRNAME> | --outdir <DIRNAME>]
            [-i <JSON PROPERTY FILE> | --infile <JSON PROPERTY_FILE>]
Comment 1 Benjamin Esquivel 2016-03-08 23:42:44 UTC 
Leo, can you please enumerate what you expect as a successful outcome of fixing this bug? I see the problem description but not the expectations.
Comment 2 Leonardo Sandoval Gonzalez 2016-03-09 14:59:07 UTC 
my description is indeed not complete.

Current output with: yocto-bsp help create


NAME
    yocto-bsp create - Create a new Yocto BSP

SYNOPSIS
    yocto-bsp create <bsp-name> <karch> [-o <DIRNAME> | --outdir <DIRNAME>]
        [-i <JSON PROPERTY FILE> | --infile <JSON PROPERTY_FILE>]


Current output with: yocto-bsp create

Usage:

 Create a new Yocto BSP

 usage: yocto-bsp create <bsp-name> <karch> [-o <DIRNAME> | --outdir <DIRNAME>]
            [-i <JSON PROPERTY FILE> | --infile <JSON PROPERTY_FILE>]


Expected output: both usage strings should include the following supported two parameters

  -c, --codedump        dump the generated code to bspgen.out
  -s, --skip-git-check  skip the git connectivity check