docs/174270: gpart(8) man page doesn't describe output of "show" command

[Bas Smeelen]

The following reply was made to PR docs/174270; it has been noted by GNATS.

From: Bas Smeelen <b.smeelen at ose.nl>
To: bug-followup at FreeBSD.org
Cc:  
Subject: Re: docs/174270: gpart(8) man page doesn't describe output of "show"
 command
Date: Mon, 10 Dec 2012 09:36:19 +0100

 This is a multi-part message in MIME format.
 --------------000701070309040301000003
 Content-Type: text/plain; charset=ISO-8859-1; format=flowed
 Content-Transfer-Encoding: 7bit
 
 On 12/08/2012 01:40 AM, Ronald F.Guilmette wrote:
 >> Number:         174270
 >> Category:       docs
 >> Synopsis:       gpart(8) man page doesn't describe output of "show" command
 
 On a 9.1 machine (FreeBSD cfd 9.1-RELEASE FreeBSD 9.1-RELEASE #1 r243880: 
 Wed Dec  5 08:15:54 CET 2012 root at cfd:/usr/obj/usr/src/sys/GENERIC  i386) I 
 have changed the man page and come up with a patch attached. I have also 
 changed references to ad0 (as stated in another mail to the lists)
 I just can't figure out how to build and install the manpage or the whole 
 gpart. This is different than most other applications, can someone provide 
 some guidelines?
 
 Would something like this do?
 
 
 >> Confidential:   no
 >> Severity:       serious
 >> Priority:       low
 >> Responsible:    freebsd-doc
 >> State:          open
 >> Quarter:
 >> Keywords:
 >> Date-Required:
 >> Class:          doc-bug
 >> Submitter-Id:   current-users
 >> Arrival-Date:   Sat Dec 08 00:50:00 UTC 2012
 >> Closed-Date:
 >> Last-Modified:
 >> Originator:     Ronald F. Guilmette
 >> Release:        FreeBSD 8.3-RELEASE amd64
 >> Organization:
 > entr0py
 >> Environment:
 > FreeBSD 8.3-RELEASE amd64
 >
 >> Description:
 > The man page for gpart(8) contains a small section describing options
 > applicable to the "show" command.  Unfortuantely, the man page utterly
 > fails to document or describe the meaning and/or proper interpretation
 > of any of the four columns of output that are generated by the "gpart show"
 > command.  This is a serious ommission.
 >
 >> How-To-Repeat:
 > man gpart
 >
 >> Fix:
 > Somebody needs to document what each of the four columns of "gpart show"
 > output are actually telling the user.
 >> Release-Note:
 >> Audit-Trail:
 >> Unformatted:
 
 
 
 --------------000701070309040301000003
 Content-Type: text/x-patch;
  name="gpartmanpatch.diff"
 Content-Transfer-Encoding: 7bit
 Content-Disposition: attachment;
  filename="gpartmanpatch.diff"
 
 Index: sbin/geom/class/part/gpart.8
 ===================================================================
 --- sbin/geom/class/part/gpart.8	(revision 244078)
 +++ sbin/geom/class/part/gpart.8	(working copy)
 @@ -455,6 +455,13 @@
  .It Cm show
  Show the current partition information of the specified geoms
  or all geoms if none are specified.
 +Default output shows the following information:
 +The first column shows the logical starting block of the
 +partition. Blocksize is 512 bytes.
 +The second column shows the partition size in blocks.
 +The third column shows the partition index.
 +The fourth column shows the partition type and a human readable
 +partition size.
  Additional options include:
  .Bl -tag -width 10n
  .It Fl l
 @@ -979,14 +986,14 @@
  Exit status is 0 on success, and 1 if the command fails.
  .Sh EXAMPLES
  Create a GPT scheme on
 -.Pa ad0 :
 +.Pa ada0 :
  .Bd -literal -offset indent
 -/sbin/gpart create -s GPT ad0
 +/sbin/gpart create -s GPT ada0
  .Ed
  .Pp
  Embed GPT bootstrap code into a protective MBR:
  .Bd -literal -offset indent
 -/sbin/gpart bootcode -b /boot/pmbr ad0
 +/sbin/gpart bootcode -b /boot/pmbr ada0
  .Ed
  .Pp
  Create a dedicated
 @@ -1011,15 +1018,15 @@
  offset or alignment.
  The boot partition itself is aligned on a 4 kB boundary.
  .Bd -literal -offset indent
 -/sbin/gpart add -b 40 -s 88 -t freebsd-boot ad0
 -/sbin/gpart bootcode -p /boot/gptboot -i 1 ad0
 +/sbin/gpart add -b 40 -s 88 -t freebsd-boot ada0
 +/sbin/gpart bootcode -p /boot/gptboot -i 1 ada0
  .Ed
  .Pp
  Create a 512MB-sized
  .Cm freebsd-ufs
  partition to contain a UFS filesystem from which the system can boot.
  .Bd -literal -offset indent
 -/sbin/gpart add -s 512M -t freebsd-ufs ad0
 +/sbin/gpart add -s 512M -t freebsd-ufs ada0
  .Ed
  .Pp
  Create an MBR scheme on
 
 
 --------------000701070309040301000003--