gpart(8) man page missing list documentation

2014-07-01 Thread Chris Ross

  Looking at the man page for gpart(8) on a recent 10-stable system, I was 
trying to find out what the -a option to list does.  (shown in the output of 
gpart when run with no parameters).  Interestingly, despite “list” being 
highlighted in paragraph text as an action for the command, it does not appear 
in the summary at the top of the page, nor in the detailed DESCRIPTION section 
that describes each of the actions.

  This appears to still be the case on HEAD, as well.  I assume this is worth 
fixing and MFC’ing?

  Thanks.

 - Chris

___
freebsd-current@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-current
To unsubscribe, send any mail to freebsd-current-unsubscr...@freebsd.org


Re: gpart(8) man page missing list documentation

2014-07-01 Thread Warren Block

On Tue, 1 Jul 2014, Chris Ross wrote:



 Looking at the man page for gpart(8) on a recent 10-stable system, I was 
trying to find out what the -a option to list does.  (shown in the output of 
gpart when run with no parameters).  Interestingly, despite ?list? being 
highlighted in paragraph text as an action for the command, it does not appear 
in the summary at the top of the page, nor in the detailed DESCRIPTION section 
that describes each of the actions.

 This appears to still be the case on HEAD, as well.  I assume this is worth 
fixing and MFC?ing?


A PR was just entered for that: 
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=191534


list and status and a couple of others that only apply for some GEOM 
modules (load, unload) are part of the base GEOM command set.  I was 
going to say we should just refer the reader to another page, maybe 
geom(8).


But gmirror(8) does include those commands in the synopsis.  We should 
be consistent with this, and I'd lean toward doing it the way gmirror(8) 
does now.

___
freebsd-current@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-current
To unsubscribe, send any mail to freebsd-current-unsubscr...@freebsd.org


Re: gpart(8) man page missing list documentation

2014-07-01 Thread mikej

On 2014-07-01 14:49, Warren Block wrote:

On Tue, 1 Jul 2014, Chris Ross wrote:



 Looking at the man page for gpart(8) on a recent 10-stable system, I 
was trying to find out what the -a option to list does.  (shown in the 
output of gpart when run with no parameters).  Interestingly, despite 
?list? being highlighted in paragraph text as an action for the 
command, it does not appear in the summary at the top of the page, nor 
in the detailed DESCRIPTION section that describes each of the 
actions.


 This appears to still be the case on HEAD, as well.  I assume this is 
worth fixing and MFC?ing?


A PR was just entered for that:
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=191534

list and status and a couple of others that only apply for some
GEOM modules (load, unload) are part of the base GEOM command set.  I
was going to say we should just refer the reader to another page,
maybe geom(8).

But gmirror(8) does include those commands in the synopsis.  We should
be consistent with this, and I'd lean toward doing it the way
gmirror(8) does now.
___
freebsd-current@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-current
To unsubscribe, send any mail to 
freebsd-current-unsubscr...@freebsd.org

Chris:

Just looked at gmirror(8) and geom(8) and I concur that having it listed 
in the

synopsis with a reference in the description would suffice nicely.

Thanks!
___
freebsd-current@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-current
To unsubscribe, send any mail to freebsd-current-unsubscr...@freebsd.org