Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 01 Jul 2014 15:00:29 -0400
From:      mikej <mikej@mikej.com>
To:        Warren Block <wblock@wonkity.com>
Cc:        freebsd-current@freebsd.org, freebsd-stable@freebsd.org, Chris Ross <cross+freebsd@distal.com>, owner-freebsd-current@freebsd.org
Subject:   Re: gpart(8) man page missing list documentation
Message-ID:  <576b495b365440555d7b036765c908ed@mail.mikej.com>
In-Reply-To: <alpine.BSF.2.11.1407011245080.79495@wonkity.com>
References:  <6D400FD8-FF1F-42AC-AC54-EA1B5723EF1B@distal.com> <alpine.BSF.2.11.1407011245080.79495@wonkity.com>

next in thread | previous in thread | raw e-mail | index | archive | help
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-unsubscribe@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!



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?576b495b365440555d7b036765c908ed>