svn commit: r210191 - head/lib/libarchive

2010-07-17 Thread Benedict Reuschling
Author: bcr (doc committer)
Date: Sat Jul 17 12:53:57 2010
New Revision: 210191
URL: http://svn.freebsd.org/changeset/base/210191

Log:
  s/an struct/a struct
  
  PR: docs/148660
  Submitted by:   Warren Block (wblock at wonkity dot com)
  Reviewed by:Tim Kientzle
  Mentored by:jkois
  MFC after:  7 days

Modified:
  head/lib/libarchive/libarchive.3

Modified: head/lib/libarchive/libarchive.3
==
--- head/lib/libarchive/libarchive.3Sat Jul 17 07:59:53 2010
(r210190)
+++ head/lib/libarchive/libarchive.3Sat Jul 17 12:53:57 2010
(r210191)
@@ -24,7 +24,7 @@
 .\
 .\ $FreeBSD$
 .\
-.Dd August 19, 2006
+.Dd July 17, 2010
 .Dt LIBARCHIVE 3
 .Os
 .Sh NAME
@@ -158,7 +158,7 @@ Each archive entry consists of a header 
 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;
___
svn-src-head@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-head
To unsubscribe, send any mail to svn-src-head-unsubscr...@freebsd.org


Re: svn commit: r210191 - head/lib/libarchive

2010-07-17 Thread Ed Schouten
Hi Benedict,

* Benedict Reuschling b...@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 ...

-- 
 Ed Schouten e...@80386.nl
 WWW: http://80386.nl/


pgpIRQ2vlHlSD.pgp
Description: PGP signature


Re: svn commit: r210191 - head/lib/libarchive

2010-07-17 Thread Benedict Reuschling
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1

Hi Ed,

Am 17.07.10 15:16, schrieb Ed Schouten:
 Hi Benedict,
 
 * Benedict Reuschling b...@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-
___
svn-src-head@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-head
To unsubscribe, send any mail to svn-src-head-unsubscr...@freebsd.org