Bug 30809

Summary: fdisk(8) cleanup
Product: Documentation Reporter: Piet Delport <siberiyan>
Component: Books & ArticlesAssignee: Tom Rhodes <trhodes>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff
none
fdisk.8.patch none

Description Piet Delport 2001-09-25 06:30:00 UTC
	Fix various minor errors in fdisk(8).
Comment 1 Gary W. Swearingen 2001-09-25 16:45:19 UTC
>  .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.
Comment 2 Piet Delport 2001-09-27 03:27:35 UTC
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:
Comment 3 Piet Delport 2001-09-27 03:40:19 UTC
Fsck, forgot to include the patch, sorry...

-- 
Piet Delport <siberiyan@mweb.co.za>
Today's subliminal thought is:
Comment 4 Giorgos Keramidas freebsd_committer freebsd_triage 2002-03-25 00:20:11 UTC
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/
Comment 5 Tom Rhodes freebsd_committer freebsd_triage 2002-04-16 16:15:00 UTC
State Changed
From-To: open->analyzed

I am currently working on patches for fdisk(8) and disklabel(8) therefore I 
will handle the closing of this PR. 


Comment 6 Tom Rhodes freebsd_committer freebsd_triage 2002-04-16 16:15:00 UTC
Responsible Changed
From-To: freebsd-doc->trhodes

I am currently working on patches for fdisk(8) and disklabel(8) therefore I 
will handle the closing of this PR.
Comment 7 Tom Rhodes freebsd_committer freebsd_triage 2002-04-18 17:26:21 UTC
State Changed
From-To: analyzed->patched

A different patch applied to CURRENT, waiting for MFC.  Thanks alot!
Comment 8 Tom Rhodes freebsd_committer freebsd_triage 2002-04-25 17:28:32 UTC
State Changed
From-To: patched->closed

Committed to stable, thanks!