Bug 175123

Summary: [geom] gpart list/status isn't documented in usage section of gpart(8)
Product: Documentation Reporter: Enji Cooper <ngie>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
See Also: https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=191534

Description Enji Cooper freebsd_committer freebsd_triage 2013-01-08 05:30:00 UTC
More items are documented in the usage text for gpart(8) than the manpage.

From gpart(8):

     gpart add -t type [-a alignment] [-b start] [-s size] [-i index]
           [-l label] [-f flags] geom
     gpart backup geom
     gpart bootcode [-b bootcode] [-p partcode -i index] [-f flags] geom
     gpart commit geom
     gpart create -s scheme [-n entries] [-f flags] provider
     gpart delete -i index [-f flags] geom
     gpart destroy [-F] [-f flags] geom
     gpart modify -i index [-l label] [-t type] [-f flags] geom
     gpart recover [-f flags] geom
     gpart resize -i index [-a alignment] [-s size] [-f flags] geom
     gpart restore [-lF] [-f flags] provider [...]
     gpart set -a attrib -i index [-f flags] geom
     gpart show [-l | -r] [-p] [geom ...]
     gpart undo geom
     gpart unset -a attrib -i index [-f flags] geom

From gpart --help:

$ gpart list --help
gpart: illegal option -- -
usage: gpart add -t type [-a alignment] [-b start] [-s size] [-i index] [-l label] [-f flags] geom
       gpart backup geom
       gpart bootcode [-b bootcode] [-p partcode -i index] [-f flags] geom
       gpart commit geom
       gpart create -s scheme [-n entries] [-f flags] provider
       gpart delete -i index [-f flags] geom
       gpart destroy [-F] [-f flags] geom
       gpart modify -i index [-l label] [-t type] [-f flags] geom
       gpart set -a attrib -i index [-f flags] geom
       gpart show [-l | -r] [-p] [geom ...]
       gpart undo geom
       gpart unset -a attrib -i index [-f flags] geom
       gpart resize -i index [-a alignment] [-s size] [-f flags] geom
       gpart restore [-lF] [-f flags] provider [...]
       gpart recover [-f flags] geom
       gpart help
       gpart list [-a] [name ...]
       gpart status [-ags] [name ...]
       gpart load [-v]
       gpart unload [-v]
Comment 1 Andrey V. Elsukov 2013-01-08 08:56:15 UTC
On 08.01.2013 09:21, Garrett Cooper wrote:
> More items are documented in the usage text for gpart(8) than the manpage.

The rest are documented in the geom(8).

-- 
WBR, Andrey V. Elsukov
Comment 2 Enji Cooper freebsd_committer freebsd_triage 2013-01-08 19:59:55 UTC
On Tue, Jan 8, 2013 at 12:56 AM, Andrey V. Elsukov <bu7cher@yandex.ru> wrote:
> On 08.01.2013 09:21, Garrett Cooper wrote:
>> More items are documented in the usage text for gpart(8) than the manpage.
>
> The rest are documented in the geom(8).

    Perhaps, but for a newbie (or forgetful people like me ;)..) there
isn't really a pointer from gpart(8) to geom(8) to note that
additional subcommands are available and note what the syntax is for
all of the commands. I would be satisfied with a more explicit pointer
to geom(8) (other than the SEE ALSO section at the bottom of the
manpage), as one doesn't exist today.
Thanks,
-Garrett
Comment 3 Enji Cooper freebsd_committer freebsd_triage 2015-12-13 22:51:23 UTC
list/load/status/unload are documented in the manpage after r269487:

$ svn log -c 269487
------------------------------------------------------------------------
r269487 | issyl0 | 2014-08-03 14:54:22 -0700 (Sun, 03 Aug 2014) | 7 lines

Add generic list, status, load and unload docs to gpart(8)

- In the style of gmirror(8).

PR:             docs/191534
Reviewed by:    gavin

------------------------------------------------------------------------