Bug 10751

Summary: Add help on all oe scripts exported to the path and display it when no required arguments are specified
Product: [Build System, Metadata & Runtime] OE-Core Reporter: Jair Gonzalez <jair.de.jesus.gonzalez.plascencia>
Component: Scripts and ToolsAssignee: Ed Bartosh <eduard.bartosh>
Status: RESOLVED FIXED QA Contact: Jair Gonzalez <jair.de.jesus.gonzalez.plascencia>
Severity: enhancement    
Priority: Medium CC: benjamin.esquivel, jair.de.jesus.gonzalez.plascencia, jose.perez.carranza, ross.burton
Version: unspecified   
Target Milestone: 2.3 M2   
Hardware: x86   
OS: Multiple   
Whiteboard:
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Don't know

Description Jair Gonzalez 2016-11-30 23:01:32 UTC
The following oe* scripts exported to the path by oe-init-build-env do NOT provide any help option (either '-h' or '--help' or showing it after missing a required argument):
- oe-buildenv-internal
- oe-find-native-sysroot
- oe-git-proxy
- oe-gnome-terminal-phonehome
- oepydevshell-internal.py
- oe-setup-builddir
- oe-setup-rpmrepo
- oe-trim-schemas

The following scripts provide a help option and display help when executed without arguments:
- oe-check-sstate
- oe-pkgdata-util
- oe-publish-sdk
- oe-selftest
- oe-run-native (this displays an usage message when missing and argument)

On the following one all parameters are optional and help is displayed on demand:
- oe-build-perf-test


The behavior should be standard for all scripts we export to the path. According to this:
- It's necessary to add a help option for scripts in the first list and standardize it for 'oe-run-native'.
- Additionally, it's necessary to display help if a script is executed without any required arguments.
Comment 1 Ed Bartosh 2016-12-08 15:28:14 UTC
Modified oe-run-native: http://lists.openembedded.org/pipermail/openembedded-core/2016-December/129861.html
Comment 5 Ed Bartosh 2016-12-09 15:04:41 UTC
oepydevshell-internal.py: http://lists.openembedded.org/pipermail/openembedded-core/2016-December/129975.html
Comment 6 Ed Bartosh 2016-12-09 15:10:46 UTC
skipped oe-gnome-terminal-phonehome due to a bug 10312
Looks like it's not working as expected.
Comment 8 Ed Bartosh 2016-12-09 16:05:48 UTC
oe-find-native-sysroot: http://lists.openembedded.org/pipermail/openembedded-core/2016-December/129977.html
Comment 10 Ed Bartosh 2016-12-14 11:14:53 UTC
All my patches have been merged into poky master.