From owner-freebsd-doc@FreeBSD.ORG Sat Aug 22 22:48:42 2009 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id E1469106568D for ; Sat, 22 Aug 2009 22:48:42 +0000 (UTC) (envelope-from minimarmot@gmail.com) Received: from mail-ew0-f209.google.com (mail-ew0-f209.google.com [209.85.219.209]) by mx1.freebsd.org (Postfix) with ESMTP id 667988FC0C for ; Sat, 22 Aug 2009 22:48:42 +0000 (UTC) Received: by ewy5 with SMTP id 5so2142065ewy.36 for ; Sat, 22 Aug 2009 15:48:41 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:mime-version:received:in-reply-to:references :date:message-id:subject:from:to:cc:content-type :content-transfer-encoding; bh=gRQDQUUJPSQt8i+K6sCiX9LC5hGCIVnMrhkb4+OwBT8=; b=twTQpcgKNcg01D+5QNtqULTng+ED9x6pjia8+HNcRW2SyJFzmnpjQDVNVH0SNyyvpY v/yBThsfP/FsoJk6FmpfsMzNK2ZxHiawgXdfuJtd0Oisx3motMkl9dGQ9gTDV5xFEEBO pyz2HIHCD2uiUbtXbrgU17ODM2nHF4TMLsbEc= DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :cc:content-type:content-transfer-encoding; b=XFTM42yRpVY3fGgHC3r2kFu0plczWludcu3Ge8+n5TXmBWLHAfoAR6JCvh9JBZV5bu z8/xR2FrOfos8LyGnsbYTP35hoxsYx+9RkSELL1a2bwZd/dDLOy4aRB63OZ/tpwsJPBI LF7xKcaWpVH/c2tFhl3m2caObeXDs3OZN9Pjg= MIME-Version: 1.0 Received: by 10.210.118.14 with SMTP id q14mr2982476ebc.31.1250981321478; Sat, 22 Aug 2009 15:48:41 -0700 (PDT) In-Reply-To: <4A71CC6D.7060803@omnilan.de> References: <4A5CB2D1.5070106@omnilan.de> <4A5EDA14.8000703@omnilan.de> <4A5F0F4F.5060505@andric.com> <4A6F52BE.9000901@omnilan.de> <9bbcef730907281255u3f426923g886893585899d210@mail.gmail.com> <4A6F5A1F.2070906@omnilan.de> <4A70B15B.4050907@andric.com> <4A713FB9.6020002@omnilan.de> <4A71CC6D.7060803@omnilan.de> Date: Sat, 22 Aug 2009 18:48:41 -0400 Message-ID: <47d0403c0908221548q5207aa10o182986d895700ad7@mail.gmail.com> From: Ben Kaduk To: Harald Schmalzbauer Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 7bit Cc: Dimitry Andric , freebsd-doc@freebsd.org Subject: Re: gmirror provider name limit [Was: Re: geom_label: gpt/labelname for gmirror provider?] X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 22 Aug 2009 22:48:43 -0000 [swapping out -current for -doc ... and yes, I'm a bit behind on my mail] On Thu, Jul 30, 2009 at 12:38 PM, Harald Schmalzbauer wrote: > Harald Schmalzbauer schrieb am 30.07.2009 08:37 (localtime): >> >> Dimitry Andric schrieb am 29.07.2009 22:30 (localtime): >> ... >>> >>> Please try the following patch, to enable an error message, in case any >>> of the providers' names exceeds the maximum length. It should be enough >>> to do "cd /usr/src/sbin/geom && make && sudo make install". >>> >>> I'm not very good at manpages, though... any takers? :) >> >> I always wanted to look into man pages from the editors side. >> Expect something toady, otherwise I'll notify when I failed... > > Here's the best I could do. I suggest some native speakers should have a > look on it. > > geom_man.diff > --- src/sbin/geom/class/raid3/graid3.8.orig 2009-07-30 > 18:20:16.000000000 +0200 > +++ src/sbin/geom/class/raid3/graid3.8 2009-07-30 18:20:51.000000000 +0200 > @@ -83,7 +83,15 @@ > The > .Nm > utility uses on-disk metadata (the provider's last sector) to store all > needed > -information. > +information. For New sentences should start on new lines, as house style. (It makes diffs easier to read, and is less confusing to the mdoc parser.) > +.Ar prov , > +it's possible to use a providers label (see I would avoid the "it's" contraction in favor of "it is". "provider's" is a possessive and needs the apostrophe. > +.Xr geom_label 8 ) > +instead of the device node. > +The size of I think s/size/length/ is more clear, but I'm not sure whether everyone would agree. > +.Ar prov > +is limited to 15 characters, so currently it's not possible to use the > GPTID Again, expand "it's" to "it is" (I think it is probably best to avoid contractions in man pages as a general rule) I think "the GPTID" should be "GPTIDs" for parallelism in the number of GPTIDs/labels. Hm, the rest of the files are touched with identical changes, so I think these comments apply equally there. -Ben Kaduk > +nor custom defined labels which are longer than 15 characters. > .Pp > The first argument to > .Nm > --- src/sbin/geom/class/shsec/gshsec.8.orig 2009-07-30 > 18:21:49.000000000 +0200 > +++ src/sbin/geom/class/shsec/gshsec.8 2009-07-30 18:25:26.000000000 +0200 > @@ -62,7 +62,16 @@ > The secret is shared between the given providers. > To collect the secret, all providers are needed. > If one of the components is missing, there is no way to get any useful data > from > -the rest of them. > +the rest of them. For > +.Ar prov , > +it's possible to use a providers label (see > +.Xr geom_label 8 ) > +instead of the device node. > +The size of > +.Ar prov > +is limited to 15 characters, so currently it's not possible to use the > GPTID > +nor custom defined labels which are longer than 15 characters. > +.Pp > The first argument to > .Nm > indicates an action to be performed: > --- src/sbin/geom/class/stripe/gstripe.8.orig 2009-07-30 > 18:23:42.000000000 +0200 > +++ src/sbin/geom/class/stripe/gstripe.8 2009-07-30 > 18:24:10.000000000 +0200 > @@ -82,7 +82,15 @@ > .Dq automatic > method uses on-disk metadata to detect devices. > Once devices are labeled, they will be automatically detected and > -configured. > +configured. For > +.Ar prov , > +it's possible to use a providers label (see > +.Xr geom_label 8 ) > +instead of the device node. > +The size of > +.Ar prov > +is limited to 15 characters, so currently it's not possible to use the > GPTID > +nor custom defined labels which are longer than 15 characters. > .Pp > The first argument to > .Nm > --- src/sbin/geom/class/concat/gconcat.8.orig 2009-07-30 > 18:16:12.000000000 +0200 > +++ src/sbin/geom/class/concat/gconcat.8 2009-07-30 > 18:26:06.000000000 +0200 > @@ -80,7 +80,15 @@ > .Dq automatic > method uses on-disk metadata to detect devices. > Once devices are labeled, they will be automatically detected and > -configured. > +configured. For > +.Ar prov , > +it's possible to use a providers label (see > +.Xr geom_label 8 ) > +instead of the device node. > +The size of > +.Ar prov > +is limited to 15 characters, so currently it's not possible to use the > GPTID > +nor custom defined labels which are longer than 15 characters. > .Pp > The first argument to > .Nm > --- src/sbin/geom/class/journal/gjournal.8.orig 2009-07-30 > 18:26:21.000000000 +0200 > +++ src/sbin/geom/class/journal/gjournal.8 2009-07-30 > 18:29:15.000000000 +0200 > @@ -125,6 +125,16 @@ > This could be a problem when an existing file system is converted to use > .Nm . > .Pp > +For > +.Ar prov , > +it's possible to use a providers label (see > +.Xr geom_label 8 ) > +instead of the device node. > +The size of > +.Ar prov > +is limited to 15 characters, so currently it's not possible to use the > GPTID > +nor custom defined labels which are longer than 15 characters. > +.Pp > The first argument to > .Nm > indicates an action to be performed: > --- src/sbin/geom/class/mirror/gmirror.8.orig 2009-07-30 > 18:11:17.000000000 +0200 > +++ src/sbin/geom/class/mirror/gmirror.8 2009-07-30 > 18:29:55.000000000 +0200 > @@ -106,7 +106,15 @@ > utility uses on-disk metadata (stored in the provider's last sector) to > store all needed > information. > Since the last sector is used for this purpose, it is possible to place a > root > -file system on a mirror. > +file system on a mirror. For > +.Ar prov , > +it's possible to use a providers label (see > +.Xr geom_label 8 ) > +instead of the device node. > +The size of > +.Ar prov > +is limited to 15 characters, so currently it's not possible to use the > GPTID > +nor custom defined labels which are longer than 15 characters. > .Pp > The first argument to > .Nm > > Best regards, > > -Harry > >