From nobody@FreeBSD.org  Tue May 31 16:44:45 2011
Return-Path: <nobody@FreeBSD.org>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id ED795106566C
	for <freebsd-gnats-submit@FreeBSD.org>; Tue, 31 May 2011 16:44:45 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from red.freebsd.org (red.freebsd.org [IPv6:2001:4f8:fff6::22])
	by mx1.freebsd.org (Postfix) with ESMTP id DE91E8FC1C
	for <freebsd-gnats-submit@FreeBSD.org>; Tue, 31 May 2011 16:44:45 +0000 (UTC)
Received: from red.freebsd.org (localhost [127.0.0.1])
	by red.freebsd.org (8.14.4/8.14.4) with ESMTP id p4VGijoY025478
	for <freebsd-gnats-submit@FreeBSD.org>; Tue, 31 May 2011 16:44:45 GMT
	(envelope-from nobody@red.freebsd.org)
Received: (from nobody@localhost)
	by red.freebsd.org (8.14.4/8.14.4/Submit) id p4VGijDt025477;
	Tue, 31 May 2011 16:44:45 GMT
	(envelope-from nobody)
Message-Id: <201105311644.p4VGijDt025477@red.freebsd.org>
Date: Tue, 31 May 2011 16:44:45 GMT
From: Ben Kaduk <kaduk@mit.edu>
To: freebsd-gnats-submit@FreeBSD.org
Subject: grammar and style nits in gpart.8
X-Send-Pr-Version: www-3.1
X-GNATS-Notify:

>Number:         157467
>Category:       docs
>Synopsis:       [patch] grammar and style nits in gpart.8
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    gavin
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Tue May 31 16:50:05 UTC 2011
>Closed-Date:    Sun Jul 03 21:09:07 UTC 2011
>Last-Modified:  Sun Jul  3 21:10:10 UTC 2011
>Originator:     Ben Kaduk
>Release:        9-current
>Organization:
MIT SIPB
>Environment:
n/a
>Description:
The attached patch fixes a few grammar nits in the man page, and corrects style by starting a sentence on a new line.
>How-To-Repeat:

>Fix:


Patch attached with submission follows:

--- gpart.8.orig	2011-05-31 12:25:46.000000000 -0400
+++ gpart.8	2011-05-31 12:42:31.000000000 -0400
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD: src/sbin/geom/class/part/gpart.8,v 1.31 2011/05/30 11:17:42 ae Exp $
 .\"
-.Dd May 30, 2011
+.Dd May 31, 2011
 .Dt GPART 8
 .Os
 .Sh NAME
@@ -794,12 +794,12 @@
 command.
 This command does reconstruction of corrupt metadata using 
 known valid metadata.
-Also it can relocate secondary GPT to the end of device.
+Also it can relocate the secondary GPT to the end of device.
 .Pp
 .Pa NOTE :
 The GEOM class PART can detect the same partition table on different GEOM 
 providers and some of them will be marked as corrupt.
-Be careful when choosing a provider for recovering.
+Be careful when choosing a provider for recovery.
 If you choose incorrectly you can destroy the metadata of another GEOM class,
 e.g. GEOM MIRROR or GEOM LABEL.
 .Sh SYSCTL VARIABLES
@@ -812,10 +812,11 @@
 .Bl -tag -width indent
 .It Va kern.geom.part.check_integrity : No 1
 This variable controls the behaviour of metadata integrity checks.
-When integrity checks are enabled
+When integrity checks are enabled, the
 .Nm PART
 GEOM class verifies all generic partition parameters that it gets from the
-disk metadata. If some inconsistency is detected, partition table will be
+disk metadata.
+If some inconsistency is detected, the partition table will be
 rejected with a diagnostic message:
 .Pa GEOM_PART: Integrity check failed (provider, scheme) .
 .Sh EXIT STATUS


>Release-Note:
>Audit-Trail:

From: Benjamin Kaduk <kaduk@MIT.EDU>
To: bug-followup@freebsd.org
Cc:  
Subject: Re: docs/157467: [patch] grammar and style nits in gpart.8
Date: Fri, 3 Jun 2011 21:14:08 -0400 (EDT)

 r222646 has introduced conflicts into the patch.  The hunks which are 
 still relevant (i.e. the grammar fixups) look like they should still be 
 applicable by hand, though.
 
 -Ben Kaduk
Responsible-Changed-From-To: freebsd-doc->gavin 
Responsible-Changed-By: gavin 
Responsible-Changed-When: Mon Jun 6 13:38:54 UTC 2011 
Responsible-Changed-Why:  
Take 

http://www.freebsd.org/cgi/query-pr.cgi?pr=157467 
State-Changed-From-To: open->patched 
State-Changed-By: gavin 
State-Changed-When: Mon Jun 6 21:03:27 UTC 2011 
State-Changed-Why:  
Changes incorporated into a larger patch now committed to head, thanks! 

http://www.freebsd.org/cgi/query-pr.cgi?pr=157467 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/157467: commit references a PR
Date: Mon,  6 Jun 2011 21:02:40 +0000 (UTC)

 Author: gavin
 Date: Mon Jun  6 21:02:26 2011
 New Revision: 222778
 URL: http://svn.freebsd.org/changeset/base/222778
 
 Log:
   Rework parts of this man page to improve grammar.
   
   Inspired by, and parts submitted by...
   PR:		docs/157467
   Submitted by:	Ben Kaduk <kaduk mit.edu>
   MFC after:	2 weeks
 
 Modified:
   head/sbin/geom/class/part/gpart.8
 
 Modified: head/sbin/geom/class/part/gpart.8
 ==============================================================================
 --- head/sbin/geom/class/part/gpart.8	Mon Jun  6 20:58:15 2011	(r222777)
 +++ head/sbin/geom/class/part/gpart.8	Mon Jun  6 21:02:26 2011	(r222778)
 @@ -24,7 +24,7 @@
  .\"
  .\" $FreeBSD$
  .\"
 -.Dd May 30, 2011
 +.Dd June 6, 2011
  .Dt GPART 8
  .Os
  .Sh NAME
 @@ -530,16 +530,17 @@ about its use.
  .El
  .\"
  .Sh PARTITION TYPES
 +Partition types are identified on disk by particular strings or magic
 +values.
  The
  .Nm
 -utility uses symbolic names for common partition types to avoid that the
 -user needs to know what the partitioning scheme in question is and what
 -the actual number or identification needs to be used for a particular
 -type.
 +utility uses symbolic names for common partition types to avoid the
 +user needing to know these values or other details of the partitioning
 +scheme in question.
  The
  .Nm
  utility also allows the user to specify scheme-specific partition types
 -for partition types that do not have symbol names.
 +for partition types that do not have symbolic names.
  The symbolic names currently understood are:
  .Bl -tag -width ".Cm freebsd-vinum"
  .It Cm bios-boot
 @@ -740,30 +741,30 @@ action or reverted with the
  .Cm undo
  action.
  .Sh RECOVERING
 -The GEOM class PART supports recovering of partition tables only for GPT.
 +The GEOM PART class supports recovering of partition tables only for GPT.
  The GUID partition table has a primary and secondary (backup) copy of
 -metadata for redundance.
 -They are stored in the begining and in the end of device respectively.
 -Therefore it is acceptable to have some corruptions in the metadata that
 -are not fatal to work with GPT.
 -When kernel detects corrupt metadata it marks this table as corrupt and
 -reports about corruption.
 -Any changes in corrupt table are prohibited except
 +metadata for redundance, these are stored at the begining and the end
 +of the device respectively.
 +As a result of having two copies, it is acceptable to have some corruption
 +within the metadata that is not fatal to the working of GPT.
 +When the kernel detects corrupt metadata it marks this table as corrupt and
 +reports the corruption.
 +Any operations on corrupt tables are prohibited except for
  .Cm destroy
  and
  .Cm recover .
  .Pp
 -In case when only first sector is corrupt kernel can not detect GPT even
 -if partition table is not corrupt.
 -You can write protective MBR with
 +If the first sector of a provider is corrupt, the kernel can not detect GPT
 +even if partition table itself is not corrupt.
 +You can rewrite the protective MBR using the
  .Xr dd 1
 -command to restore ability of GPT detection.
 -The copy of protective MBR is usually located in the
 +command, to restore the ability to detect the GPT.
 +The copy of the protective MBR is usually located in the
  .Pa /boot/pmbr
  file.
  .Pp
 -In case when some of metadata is corrupt you will get to know about this
 -from kernel's messages like these:
 +If one GPT header appears to be corrupt but the other copy remains intact,
 +the kernel will log the following:
  .Bd -literal -offset indent
  GEOM: provider: the primary GPT table is corrupt or invalid.
  GEOM: provider: using the secondary instead -- recovery strongly advised.
 @@ -777,32 +778,31 @@ GEOM: provider: using the primary only -
  .Pp
  Also
  .Nm
 -commands like
 +commands such as
  .Cm show , status
  and
  .Cm list
 -will report about corrupt table.
 +will report about corrupt tables.
  .Pp
 -In case when the size of device has changed (e.g.\& volume expansion) the
 -secondary GPT header will become located not in the last sector.
 +If the size of the device has changed (e.g.\& volume expansion) the
 +secondary GPT header will no longer be located in the last sector.
  This is not a metadata corruption, but it is dangerous because any
 -corruption of the primary GPT will lead to lost of partition table.
 -Kernel reports about this problem with message:
 +corruption of the primary GPT will lead to loss of partition table.
 +This problem is reported by the kernel with the message:
  .Bd -literal -offset indent
  GEOM: provider: the secondary GPT header is not in the last LBA.
  .Ed
  .Pp
 -A corrupt table can be recovered with
 +This situation can be recovered with the
  .Cm recover
  command.
 -This command does reconstruction of corrupt metadata using
 -known valid metadata.
 -Also it can relocate secondary GPT to the end of device.
 +This command reconstructs the corrupt metadata using known valid
 +metadata and relocates the secondary GPT to the end of the device.
  .Pp
  .Em NOTE :
 -The GEOM class PART can detect the same partition table on different GEOM
 -providers and some of them will be marked as corrupt.
 -Be careful when choosing a provider for recovering.
 +The GEOM PART class can detect the same partition table visible through
 +different GEOM providers, and some of them will be marked as corrupt.
 +Be careful when choosing a provider for recovery.
  If you choose incorrectly you can destroy the metadata of another GEOM class,
  e.g.\& GEOM MIRROR or GEOM LABEL.
  .Sh SYSCTL VARIABLES
 @@ -815,11 +815,11 @@ The default value is shown next to each 
  .Bl -tag -width indent
  .It Va kern.geom.part.check_integrity : No 1
  This variable controls the behaviour of metadata integrity checks.
 -When integrity checks are enabled
 +When integrity checks are enabled, the
  .Nm PART
 -GEOM class verifies all generic partition parameters that it gets from the
 +GEOM class verifies all generic partition parameters obtained from the
  disk metadata.
 -If some inconsistency is detected, partition table will be
 +If some inconsistency is detected, the partition table will be
  rejected with a diagnostic message:
  .Sy "GEOM_PART: Integrity check failed (provider, scheme)" .
  .El
 _______________________________________________
 svn-src-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/svn-src-all
 To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
 
State-Changed-From-To: patched->closed 
State-Changed-By: gavin 
State-Changed-When: Sun Jul 3 21:08:46 UTC 2011 
State-Changed-Why:  
Merged to stable/8, thanks! 

http://www.freebsd.org/cgi/query-pr.cgi?pr=157467 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/157467: commit references a PR
Date: Sun,  3 Jul 2011 21:07:40 +0000 (UTC)

 Author: gavin
 Date: Sun Jul  3 21:07:21 2011
 New Revision: 223746
 URL: http://svn.freebsd.org/changeset/base/223746
 
 Log:
   Merge r222778 from head:
   
     Rework parts of this man page to improve grammar.
   
   PR:		docs/157467 (partially)
   Submitted by:	Ben Kaduk <kaduk mit.edu> (partially)
 
 Modified:
   stable/8/sbin/geom/class/part/gpart.8
 Directory Properties:
   stable/8/sbin/geom/class/part/   (props changed)
 
 Modified: stable/8/sbin/geom/class/part/gpart.8
 ==============================================================================
 --- stable/8/sbin/geom/class/part/gpart.8	Sun Jul  3 21:05:10 2011	(r223745)
 +++ stable/8/sbin/geom/class/part/gpart.8	Sun Jul  3 21:07:21 2011	(r223746)
 @@ -24,7 +24,7 @@
  .\"
  .\" $FreeBSD$
  .\"
 -.Dd March 12, 2011
 +.Dd June 6, 2011
  .Dt GPART 8
  .Os
  .Sh NAME
 @@ -505,16 +505,17 @@ about its use.
  .El
  .\"
  .Sh PARTITION TYPES
 +Partition types are identified on disk by particular strings or magic
 +values.
  The
  .Nm
 -utility uses symbolic names for common partition types to avoid that the
 -user needs to know what the partitioning scheme in question is and what
 -the actual number or identification needs to be used for a particular
 -type.
 +utility uses symbolic names for common partition types to avoid the
 +user needing to know these values or other details of the partitioning
 +scheme in question.
  The
  .Nm
  utility also allows the user to specify scheme-specific partition types
 -for partition types that do not have symbol names.
 +for partition types that do not have symbolic names.
  The symbolic names currently understood are:
  .Bl -tag -width ".Cm freebsd-vinum"
  .It Cm bios-boot
 @@ -715,30 +716,30 @@ action or reverted with the
  .Cm undo
  action.
  .Sh RECOVERING
 -The GEOM class PART supports recovering of partition tables only for GPT.
 +The GEOM PART class supports recovering of partition tables only for GPT.
  The GUID partition table has a primary and secondary (backup) copy of
 -metadata for redundance.
 -They are stored in the begining and in the end of device respectively.
 -Therefore it is acceptable to have some corruptions in the metadata that
 -are not fatal to work with GPT.
 -When kernel detects corrupt metadata it marks this table as corrupt and
 -reports about corruption.
 -Any changes in corrupt table are prohibited except
 +metadata for redundance, these are stored at the begining and the end
 +of the device respectively.
 +As a result of having two copies, it is acceptable to have some corruption
 +within the metadata that is not fatal to the working of GPT.
 +When the kernel detects corrupt metadata it marks this table as corrupt and
 +reports the corruption.
 +Any operations on corrupt tables are prohibited except for
  .Cm destroy
  and
  .Cm recover . 
  .Pp
 -In case when only first sector is corrupt kernel can not detect GPT even
 -if partition table is not corrupt.
 -You can write protective MBR with
 +If the first sector of a provider is corrupt, the kernel can not detect GPT
 +even if partition table itself is not corrupt.
 +You can rewrite the protective MBR using the
  .Xr dd 1
 -command to restore ability of GPT detection.
 -The copy of protective MBR is usually located in the
 +command, to restore the ability to detect the GPT.
 +The copy of the protective MBR is usually located in the
  .Pa /boot/pmbr
  file.
  .Pp
 -In case when some of metadata is corrupt you will get to know about this
 -from kernel's messages like these:
 +If one GPT header appears to be corrupt but the other copy remains intact,
 +the kernel will log the following:
  .Bd -literal -offset indent
  GEOM: provider: the primary GPT table is corrupt or invalid.
  GEOM: provider: using the secondary instead -- recovery strongly advised.
 @@ -750,37 +751,35 @@ GEOM: provider: the secondary GPT table 
  GEOM: provider: using the primary only -- recovery suggested.
  .Ed
  .Pp
 -Also 
 -.Cm gpart 
 -commands like 
 -.Cm show ,
 -.Cm status
 +Also
 +.Nm
 +commands such as
 +.Cm show , status
  and
  .Cm list
 -will report about corrupt table.
 +will report about corrupt tables.
  .Pp
 -In case when the size of device has changed (e.g. volume expansion) the 
 -secondary GPT header will become located not in the last sector.
 +If the size of the device has changed (e.g.\& volume expansion) the
 +secondary GPT header will no longer be located in the last sector.
  This is not a metadata corruption, but it is dangerous because any
 -corruption of the primary GPT will lead to lost of partition table.
 -Kernel reports about this problem with message:
 +corruption of the primary GPT will lead to loss of partition table.
 +This problem is reported by the kernel with the message:
  .Bd -literal -offset indent
  GEOM: provider: the secondary GPT header is not in the last LBA.
  .Ed
  .Pp
 -A corrupt table can be recovered with 
 -.Cm gpart recover 
 +This situation can be recovered with the
 +.Cm recover
  command.
 -This command does reconstruction of corrupt metadata using 
 -known valid metadata.
 -Also it can relocate secondary GPT to the end of device.
 -.Pp
 -.Pa NOTE :
 -The GEOM class PART can detect the same partition table on different GEOM 
 -providers and some of them will be marked as corrupt.
 -Be careful when choosing a provider for recovering.
 +This command reconstructs the corrupt metadata using known valid
 +metadata and relocates the secondary GPT to the end of the device.
 +.Pp
 +.Em NOTE :
 +The GEOM PART class can detect the same partition table visible through
 +different GEOM providers, and some of them will be marked as corrupt.
 +Be careful when choosing a provider for recovery.
  If you choose incorrectly you can destroy the metadata of another GEOM class,
 -e.g. GEOM MIRROR or GEOM LABEL.
 +e.g.\& GEOM MIRROR or GEOM LABEL.
  .Sh EXIT STATUS
  Exit status is 0 on success, and 1 if the command fails.
  .Sh EXAMPLES
 _______________________________________________
 svn-src-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/svn-src-all
 To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
 
>Unformatted:
