From pjd@siberiyan.dyndns.org  Mon Sep 24 22:26:37 2001
Return-Path: <pjd@siberiyan.dyndns.org>
Received: from msg-proxy4.mweb.co.za (msg-proxy4.mweb.co.za [196.2.46.16])
	by hub.freebsd.org (Postfix) with ESMTP id D44AA37B419
	for <FreeBSD-gnats-submit@freebsd.org>; Mon, 24 Sep 2001 22:26:36 -0700 (PDT)
Received: from athalon. ([196.30.181.159])
 by msg-proxy4.mweb.co.za (iPlanet Messaging Server 5.1 (built May  7 2001))
 with ESMTP id <0GK7005GQDS7A4@msg-proxy4.mweb.co.za> for
 FreeBSD-gnats-submit@freebsd.org; Tue, 25 Sep 2001 07:26:33 +0200 (SAST)
Received: (from pjd@siberiyan.dyndns.org)
	by siberiyan.dyndns.org (8.11.6/8.11.6) id f8NMhNu02826; Mon,
 24 Sep 2001 00:43:23 +0200 (SAST envelope-from pjd)
Message-Id: <200109232243.f8NMhNu02826@siberiyan.dyndns.org>
Date: Mon, 24 Sep 2001 00:43:23 +0200 (SAST)
From: Piet Delport <siberiyan@mweb.co.za>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: fdisk(8) cleanup
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         30809
>Category:       docs
>Synopsis:       fdisk(8) cleanup
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    trhodes
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Mon Sep 24 22:30:00 PDT 2001
>Closed-Date:    Thu Apr 25 09:28:58 PDT 2002
>Last-Modified:  Thu Apr 25 09:28:58 PDT 2002
>Originator:     Piet Delport
>Release:        FreeBSD 4.4-STABLE i386
>Organization:
>Environment:
System: FreeBSD athalon 4.4-STABLE FreeBSD 4.4-STABLE #9: Sun Sep 23 07:40:24 SAST 2001 root@athalon:/usr/obj/usr/src/sys/ATHALON i386


	
>Description:

	Fix various minor errors in fdisk(8).

>How-To-Repeat:

>Fix:

--- sbin/i386/fdisk/fdisk.8.orig	Thu Aug 16 13:35:43 2001
+++ sbin/i386/fdisk/fdisk.8	Sun Sep 23 02:42:24 2001
@@ -131,10 +131,11 @@
 .Ql ad0 ,
 and
 .Ql da0
-are being searched in that order, until one is
-being found responding.
+are searched in that order, until one is found to respond.
 .Pp
-When called with no arguments, it prints the sector 0 partition table.
+When called with no arguments,
+.Nm
+prints the sector 0 partition table.
 An example follows:
 .Bd -literal
 	******* Working on device /dev/ad0 *******
@@ -180,18 +181,17 @@
 .It Em "flag 80"
 specifies that this is the active partition.
 .It Em cyl , sector No and Em head
-fields are used to specify the beginning address
-and end address for the partition.
+fields are used to specify the beginning and end addresses of the partition.
 .It Em Note :
 these numbers are calculated using BIOS's understanding of the disk geometry
 and saved in the bootblock.
 .El
 .Pp
-The flags
+The
 .Fl i
 or
 .Fl u
-are used to indicate that the partition data is to be updated, unless the
+flags are used to indicate that the partition data is to be updated, unless the
 .Fl f
 option is used.  If the
 .Fl f
@@ -203,7 +203,7 @@
 selects defaults for its questions to guarantee the above behavior.
 .Pp
 It displays each partition
-and ask if you want to edit it.
+and asks whether you want to edit it.
 If you say yes,
 it will step through each field showing the old value
 and asking for a new one.
@@ -227,20 +227,18 @@
 .Em active
 partition.
 Finally,
-when the all the data for the first sector has been accumulated,
-you are asked if you really want to rewrite sector 0.
-Only if you answer yes,
-will the data be written to disk.
+when all the data for sector 0 has been accumulated,
+you are asked to confirm whether you really want to rewrite it.
 .Pp
 The difference between the
 .Fl u
-flag and
+and
 .Fl i
-flag is that
+flags is that
 the
 .Fl u
-flag just edits the fields as they appear on the disk.
-While the
+flag just edits (updates) the fields as they appear on the disk,
+while the
 .Fl i
 flag is used to "initialize" sector 0;
 it will setup the last BIOS partition to use the whole disk for
@@ -248,9 +246,9 @@
 and make it active.
 .Sh NOTES
 The automatic calculation of starting cylinder etc. uses
-a set of figures that represent what the BIOS thinks is the
-geometry of the drive.
-These figures are by default taken from the incore disklabel,
+a set of figures that represent what the BIOS thinks the
+geometry of the drive is.
+These figures are taken from the incore disklabel by default,
 but the program initially gives you an opportunity to change them.
 This allows the user to create a bootblock that can work with drives
 that use geometry translation under the BIOS.
@@ -276,7 +274,7 @@
 from a
 .Ar configfile .
 The syntax of this file is very simple.  Each line is either a comment or
-a specification, and whitespace (except for newlines) are ignored:
+a specification, and whitespace (except for newlines) is not significant:
 .Bl -tag -width Ds
 .It Xo
 .Ic #
>Release-Note:
>Audit-Trail:

From: swear@blarg.net (Gary W. Swearingen)
To: Piet Delport <siberiyan@mweb.co.za>
Cc: FreeBSD-gnats-submit@FreeBSD.ORG
Subject: Re: docs/30809: fdisk(8) cleanup
Date: 25 Sep 2001 08:45:19 -0700

 >  .Pp
 > -When called with no arguments, it prints the sector 0 partition table.
 > +When called with no arguments,
                        ^^^^^^^^^  Should be "options".
 (The only argument is "disk".)
 
 > -The flags
 > +The
 >  .Fl i
 >  or
    ^^  Should be "and"; "or" sounds like the writer doesn't know which flag.
 
 >  The syntax of this file is very simple.  Each line is either a comment or
 > -a specification, and whitespace (except for newlines) are ignored:
 > +a specification, and whitespace (except for newlines) is not significant:
 
 How about: 
 > +a specification, as follows.
 
 Newlines are part of the presumed definition of a line and shouldn't be
 mentioned (or if the handling is weird, it needs much more discussion).
 
 Whitespace IS significant and is NOT ignored and explaining it carefully
 shouldn't be required in every man page.

From: Piet Delport <siberiyan@mweb.co.za>
To: FreeBSD-gnats-submit@FreeBSD.ORG
Cc:  
Subject: Re: docs/30809: fdisk(8) cleanup
Date: Thu, 27 Sep 2001 04:27:35 +0200

 On Tue, 25 Sep 2001 at 09:20:02 -0700, Gary W. Swearingen wrote:
 [snip]
 
 Thanks!
 
 I've worked your changes into the patch, along with several other
 additions.
 
 The overall organisation of the manpage is still not as good as it can
 be, i think, but i lack enough knowledge of exactly how fdisk works to
 fix that, and hope this is enough, at least for now.
 
 -- 
 Piet Delport <siberiyan@mweb.co.za>
 Today's subliminal thought is:

From: Piet Delport <siberiyan@mweb.co.za>
To: FreeBSD-gnats-submit@FreeBSD.ORG
Cc:  
Subject: Re: docs/30809: fdisk(8) cleanup
Date: Thu, 27 Sep 2001 04:40:19 +0200

 --Boundary_(ID_k5eDihN5/pTKcOG9fRZCOg)
 Content-type: text/plain; charset=us-ascii
 Content-transfer-encoding: 7BIT
 Content-disposition: inline
 
 Fsck, forgot to include the patch, sorry...
 
 -- 
 Piet Delport <siberiyan@mweb.co.za>
 Today's subliminal thought is:
 
 --Boundary_(ID_k5eDihN5/pTKcOG9fRZCOg)
 Content-type: text/plain; charset=us-ascii; NAME=fdisk.8.patch
 Content-transfer-encoding: 7BIT
 Content-disposition: attachment; filename=fdisk.8.patch
 
 --- sbin/i386/fdisk/fdisk.8.orig	Thu Aug 16 13:35:43 2001
 +++ sbin/i386/fdisk/fdisk.8	Thu Sep 27 01:15:59 2001
 @@ -131,10 +131,11 @@
  .Ql ad0 ,
  and
  .Ql da0
 -are being searched in that order, until one is
 -being found responding.
 +are searched in that order, until one is found to respond.
  .Pp
 -When called with no arguments, it prints the sector 0 partition table.
 +When called with no options, 
 +.Nm
 +prints the sector 0 partition table.
  An example follows:
  .Bd -literal
  	******* Working on device /dev/ad0 *******
 @@ -180,36 +181,35 @@
  .It Em "flag 80"
  specifies that this is the active partition.
  .It Em cyl , sector No and Em head
 -fields are used to specify the beginning address
 -and end address for the partition.
 +fields are used to specify the beginning and end addresses of the partition.
  .It Em Note :
  these numbers are calculated using BIOS's understanding of the disk geometry
  and saved in the bootblock.
  .El
  .Pp
 -The flags
 +The
  .Fl i
 -or
 +and
  .Fl u
 -are used to indicate that the partition data is to be updated, unless the
 -.Fl f
 -option is used.  If the
 +flags are used to indicate that the partition data is to be updated.
 +Unless the
  .Fl f
 -option is not used, the
 +option is also given,
  .Nm
 -program will enter a conversational mode.
 -This mode is designed not to change any data unless you explicitly tell it to.
 -.Nm Fdisk
 -selects defaults for its questions to guarantee the above behavior.
 +will enter a conversational mode.
 +In this mode, no changes will be written to disk unless you explicitly tell
 +.Nm
 +to.
  .Pp
 -It displays each partition
 -and ask if you want to edit it.
 +.Nm Fdisk
 +will display each partition and ask whether you want to edit it.
  If you say yes,
 -it will step through each field showing the old value
 -and asking for a new one.
 -When you are done with a partition,
  .Nm
 -will display it and ask if it is correct.
 +will step through each field, show you the old value,
 +and ask you for a new one.
 +When you are done with the partition,
 +.Nm
 +will display it and ask you whether it is correct.
  .Nm Fdisk
  will then proceed to the next entry.
  .Pp
 @@ -217,30 +217,26 @@
  .Em cyl , sector ,
  and
  .Em head
 -fields correct is tricky.
 -So by default,
 +fields correct is tricky, so by default,
  they will be calculated for you;
 -you can specify them if you choose.
 +you can specify them if you choose to though.
  .Pp
  After all the partitions are processed,
  you are given the option to change the
  .Em active
  partition.
 -Finally,
 -when the all the data for the first sector has been accumulated,
 -you are asked if you really want to rewrite sector 0.
 -Only if you answer yes,
 -will the data be written to disk.
 +Finally, when all the new data for sector 0 has been accumulated,
 +you are asked to confirm whether you really want to rewrite it.
  .Pp
  The difference between the
  .Fl u
 -flag and
 +and
  .Fl i
 -flag is that
 +flags is that
  the
  .Fl u
 -flag just edits the fields as they appear on the disk.
 -While the
 +flag just edits (updates) the fields as they appear on the disk,
 +while the
  .Fl i
  flag is used to "initialize" sector 0;
  it will setup the last BIOS partition to use the whole disk for
 @@ -248,11 +244,13 @@
  and make it active.
  .Sh NOTES
  The automatic calculation of starting cylinder etc. uses
 -a set of figures that represent what the BIOS thinks is the
 -geometry of the drive.
 -These figures are by default taken from the incore disklabel,
 -but the program initially gives you an opportunity to change them.
 -This allows the user to create a bootblock that can work with drives
 +a set of figures that represent what the BIOS thinks the
 +geometry of the drive is.
 +These figures are taken from the in-core disklabel by default,
 +but
 +.Nm
 +initially gives you an opportunity to change them.
 +This allows you to create a bootblock that can work with drives
  that use geometry translation under the BIOS.
  .Pp
  If you hand craft your disk layout,
 @@ -262,21 +260,24 @@
  A number of decisions made later may assume this.
  (This might not be necessary later.)
  .Pp
 -Editing an existing partition will most likely cause you to
 -lose all the data in that partition.
 +Editing an existing partition will most likely result in the loss of
 +all data in that partition.
  .Pp
 -You should run this program interactively once or twice to see how it
 -works.  This is completely safe as long as you answer the last question
 -in the negative.  There are subtleties that the program detects that are
 -not fully explained in this manual page.
 +You should run
 +.Nm
 +interactively once or twice to see how it works.
 +This is completely safe as long as you answer the last question
 +in the negative.  There are subtleties that
 +.Nm
 +detects that are not fully explained in this manual page.
  .Sh CONFIGURATION FILE
  When the
  .Fl f
  option is given, a disk's partition table can be written using values
  from a
  .Ar configfile .
 -The syntax of this file is very simple.  Each line is either a comment or
 -a specification, and whitespace (except for newlines) are ignored:
 +The syntax of this file is very simple;
 +each line is either a comment or a specification, as follows:
  .Bl -tag -width Ds
  .It Xo
  .Ic #
 @@ -323,7 +324,7 @@
  .Ed
  .Pp
  The number of cylinders should be less than or equal to 1024, but this
 -is not enforced, although a warning will be output.  Note that bootable
 +is not enforced, although a warning will be printed.  Note that bootable
  .Fx
  partitions (the "/" filesystem) must lie completely within the
  first 1024 cylinders; if this is not true, booting may fail.
 
 --Boundary_(ID_k5eDihN5/pTKcOG9fRZCOg)--

From: Giorgos Keramidas <keramida@freebsd.org>
To: Piet Delport <siberiyan@mweb.co.za>
Cc: bug-followup@freebsd.org
Subject: Re: docs/30809: fdisk(8) cleanup
Date: Mon, 25 Mar 2002 02:20:11 +0200

 On 2001-09-24 00:43, Piet Delport wrote:
 > 	Fix various minor errors in fdisk(8).
 
 I've seen this patch last night, and tried to read it carefully.
 
 Most of the changes look fine.  Last night, I took the libery to prepare a
 new patch for RELENG_4 that has a few differences from the original you
 posted.  Could you take a look at the diff I uploaded to:
 http://people.FreeBSD.org/~keramida/diff/fdisk.diff
 and tell me what you think?
 
 Just reworded a few things here and there, and tried to make it hard for
 the reader to misunderstand things.  If you feel like this is still worth
 it, I'd like to hear your comments/suggestions/changes and have this
 committed to STABLE when we bring it to a shape that we all like :-)
 
 Giorgos Keramidas                       FreeBSD Documentation Project
 keramida@{freebsd.org,ceid.upatras.gr}  http://www.FreeBSD.org/docproj/
State-Changed-From-To: open->analyzed 
State-Changed-By: trhodes 
State-Changed-When: Tue Apr 16 08:15:00 PDT 2002 
State-Changed-Why:  
I am currently working on patches for fdisk(8) and disklabel(8) therefore I 
will handle the closing of this PR. 


Responsible-Changed-From-To: freebsd-doc->trhodes 
Responsible-Changed-By: trhodes 
Responsible-Changed-When: Tue Apr 16 08:15:00 PDT 2002 
Responsible-Changed-Why:  
I am currently working on patches for fdisk(8) and disklabel(8) therefore I 
will handle the closing of this PR. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=30809 
State-Changed-From-To: analyzed->patched 
State-Changed-By: trhodes 
State-Changed-When: Thu Apr 18 09:26:21 PDT 2002 
State-Changed-Why:  
A different patch applied to CURRENT, waiting for MFC.  Thanks alot! 

http://www.freebsd.org/cgi/query-pr.cgi?pr=30809 
State-Changed-From-To: patched->closed 
State-Changed-By: trhodes 
State-Changed-When: Thu Apr 25 09:28:32 PDT 2002 
State-Changed-Why:  
Committed to stable, thanks! 

http://www.freebsd.org/cgi/query-pr.cgi?pr=30809 
>Unformatted:
