After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 740097 - Various manpage / usage blurb improvements
Various manpage / usage blurb improvements
Status: RESOLVED FIXED
Product: ostree
Classification: Infrastructure
Component: general
2014.4
Other Linux
: Normal normal
: ---
Assigned To: OSTree maintainer(s)
OSTree maintainer(s)
Depends on:
Blocks:
 
 
Reported: 2014-11-14 02:49 UTC by Matthew Barnes
Modified: 2014-11-16 21:01 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
Proposed patch (29.87 KB, patch)
2014-11-14 02:49 UTC, Matthew Barnes 		committed Details | Review

Description Matthew Barnes 2014-11-14 02:49:18 UTC 
Created attachment 290678 [details] [review]
Proposed patch

While reading through OSTree's manpages and --help blurbs I noted a number of errors and inconsistencies in the command syntax, plus some option descriptions that I thought could be worded a little better.

This patch is based on my notes.
Comment 1 Matthew Barnes 2014-11-14 02:54:05 UTC 
Couple followup questions:

"ostree admin instutil grub2-generate" is not mentioned in the manpage.  The ostree_cmd__private__() call made me wonder if that's intentional.  Is it an oversight or a hidden feature?

The "ostree admin switch" code implements what looks like a --reboot option, but there's no GOptionEntry for it so it's not possible to invoke.  Another oversight, or did you decide against a --reboot option for "switch"?
Comment 2 Colin Walters 2014-11-14 15:04:05 UTC 
Review of attachment 290678 [details] [review]:

Nice, thank you!