svn commit: r210191 - head/lib/libarchive

[Benedict Reuschling]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi Ed,

Am 17.07.10 15:16, schrieb Ed Schouten:
> Hi Benedict,
> 
> * Benedict Reuschling <bcr at FreeBSD.org> 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-----