From owner-svn-src-all@FreeBSD.ORG Sat Jul 17 15:35:08 2010 Return-Path: Delivered-To: svn-src-all@FreeBSD.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 15F771065673; Sat, 17 Jul 2010 15:35:08 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from mxout0.bln1.prohost.de (mxout0.bln1.prohost.de [213.160.84.46]) by mx1.freebsd.org (Postfix) with ESMTP id 970398FC17; Sat, 17 Jul 2010 15:35:07 +0000 (UTC) Received: from Macintosh.local (p4FC7523A.dip.t-dialin.net [79.199.82.58]) (authenticated bits=0) by mx1.bln1.prohost.de (8.14.1/8.14.1) with ESMTP id o6HFNepv023388 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Sat, 17 Jul 2010 17:23:41 +0200 Message-ID: <4C41CAFF.60208@FreeBSD.org> Date: Sat, 17 Jul 2010 17:23:43 +0200 From: Benedict Reuschling Organization: The FreeBSD Project User-Agent: Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; de; rv:1.9.2.4) Gecko/20100608 Thunderbird/3.1 MIME-Version: 1.0 To: Ed Schouten References: <201007171253.o6HCrvbJ032709@svn.freebsd.org> <20100717131601.GX1742@hoeg.nl> In-Reply-To: <20100717131601.GX1742@hoeg.nl> X-Enigmail-Version: 1.1.1 OpenPGP: id=4A819348 Content-Type: text/plain; charset=ISO-8859-15 Content-Transfer-Encoding: 7bit X-Null-Tag: e76b737e49f26e068b3026fdd7ed1c34 Cc: svn-src-head@FreeBSD.org, svn-src-all@FreeBSD.org, src-committers@FreeBSD.org Subject: Re: svn commit: r210191 - head/lib/libarchive X-BeenThere: svn-src-all@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list Reply-To: bcr@FreeBSD.org List-Id: "SVN commit messages for the entire src tree \(except for " user" and " projects" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 17 Jul 2010 15:35:08 -0000 -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Hi Ed, Am 17.07.10 15:16, schrieb Ed Schouten: > Hi Benedict, > > * Benedict Reuschling wrote: >> amount of data. >> You can obtain the next header with >> .Fn archive_read_next_header , >> -which returns a pointer to an >> +which returns a pointer to a >> .Tn struct archive_entry >> structure with information about the current archive element. >> If the entry is a regular file, then the header will be followed >> @@ -324,7 +324,7 @@ or the arbitrary key/value pairs that ca >> pax interchange format archives. >> .Pp >> Conversely, of course, not all of the information that can be >> -stored in an >> +stored in a >> .Tn struct archive_entry >> is supported by all formats. >> For example, cpio formats do not support nanosecond timestamps; > > Wouldn't it be better to change it the other way around, by removing the > `struct' word? > > "... which returns a pointer to an archive_entry structure with ..." > the way I see it, "struct something structure" has a redundant struct (or structure) when read with my "normal english sentence" glasses on. However, in this case it is important for the understanding that archive_entry IS a struct and therefore the "struct archive_entry" must be read as a source code example within the text (partly looking through my source code glasses). There are more places in this man page where the struct is placed similarly, so for the sake of consistency, I would prefer to leave it as it is now. If that man page was not primarily written for developers (which I think it is), I would agree with you on that. Your suggestion is right, nonetheless. Regards (or "Groetjes", as I've learned recently) ;-) Benedict Reuschling The FreeBSD Documentation Project FreeBSD German Documentation Project - https://doc.bsdgroup.de -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.8 (Darwin) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iEYEARECAAYFAkxByvcACgkQTSZQLkqBk0i5wwCgpVzqlGPHSrMBluRBJFmktgFe gHEAnRpzUCz5JHirYYsIxeU/IM8b28fB =Lk3C -----END PGP SIGNATURE-----