| Summary: | dev-util/pkgdev-0.1.9: improve help text for --message/-m and add -e to --help/-h output | ||
|---|---|---|---|
| Product: | Gentoo Hosted Projects | Reporter: | Randall <ran.dall> |
| Component: | PkgCore | Assignee: | PkgCore project <pkgcore> |
| Status: | RESOLVED FIXED | ||
| Severity: | normal | CC: | arthurzam, mgorny, pacho, sam |
| Priority: | Normal | ||
| Version: | unspecified | ||
| Hardware: | All | ||
| OS: | Linux | ||
| Whiteboard: | |||
| Package list: | Runtime testing required: | --- | |
After checking once again, it seems like a much better explanation of the options exists as the longer doc variable. This one can be viewed at [1]. But, even if using the "doc" use flag, the generated man page is incorrect, so the bug still exists. [1] https://pkgcore.github.io/pkgdev/man/pkgdev.html `-m` is well documented, but `-e` wasn't at all Fixed in https://gitweb.gentoo.org/proj/pkgcore/pkgdev.git/commit/?h=main&id=ee0e2cb11 |
Currently in the output of --help/-h, it displays... ``` ... -m MSG, --message MSG specify commit message ... ``` This isn't 100% correct, as the intention for --message/-m users to use this for a titling their commits, and to use -e to users to write the commit's message. Therefore, I purpose the following edits. ``` ... -m MSG, --message MSG specify commit title or commit message to add or edit a multi-line commit message use "pkgdev -e" ... ``` Maybe some example would also be useful to avoid any misconceptions, such as... ``` ... Examples: pkgdev -as pkgdev -asu -m "commit title" -m "commit message" pkgdev -asu -e ``` Reproducible: Always