Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 846785 - dev-util/pkgdev-0.1.9: improve help text for --message/-m and add -e to --help/-h output
Summary: dev-util/pkgdev-0.1.9: improve help text for --message/-m and add -e to --hel...
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Hosted Projects
Classification: Unclassified
Component: PkgCore (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: PkgCore project
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2022-05-21 18:21 UTC by Randall
Modified: 2022-10-26 19:08 UTC (History)
4 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Randall 2022-05-21 18:21:30 UTC
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
Comment 1 Arthur Zamarin archtester Gentoo Infrastructure gentoo-dev Security 2022-05-28 05:34:51 UTC
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
Comment 2 Arthur Zamarin archtester Gentoo Infrastructure gentoo-dev Security 2022-10-26 19:08:59 UTC
`-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