cvs commit: src/include fts.h

[Peter Jeremy]

On Fri, 2005-Jan-07 00:06:20 +0000, Pawel Jakub Dawidek wrote:
>  Introduce new field 'fts_bignum' which is 64bit long and will allow to
>  make utilities like du(1) 64bit-clean.
>  When this field is used, one cannot use 'fts_number' and 'fts_pointer'
>  fields.

Can you please document this in fts(3).  Something along the lines of:

Index: fts.3
===================================================================
RCS file: /usr/ncvs/src/lib/libc/gen/fts.3,v
retrieving revision 1.20
diff -u -r1.20 fts.3
--- fts.3	2 Jul 2004 23:52:10 -0000	1.20
+++ fts.3	7 Jan 2005 01:56:10 -0000
@@ -147,6 +147,7 @@
 	int fts_errno;			/* file errno */
 	long fts_number;		/* local numeric value */
 	void *fts_pointer;		/* local address value */
+	int64_t fts_bignum;		/* local 64-bit numeric value */
 	struct ftsent *fts_parent;	/* parent directory */
 	struct ftsent *fts_link;	/* next file structure */
 	struct ftsent *fts_cycle;	/* cycle structure */
@@ -295,6 +296,8 @@
 .Nm
 functions.
 It is initialized to 0.
+Note that this field is overlaid by
+.Fa fts_bignum .
 .It Fa fts_pointer
 This field is provided for the use of the application program and is
 not modified by the
@@ -302,6 +305,18 @@
 functions.
 It is initialized to
 .Dv NULL .
+Note that this field is overlaid by
+.Fa fts_bignum .
+.It Fa fts_bignum
+This field is provided for the use of the application program and is
+not modified by the
+.Nm
+functions.
+It is initialized to 0.
+Note that this field overlays
+.Fa fts_number
+and
+.Fa fts_pointer .
 .It Fa fts_parent
 A pointer to the
 .Vt FTSENT
@@ -311,6 +326,7 @@
 A parent structure for the initial entry point is provided as well,
 however, only the
 .Fa fts_level ,
+.Fa fts_bignum ,
 .Fa fts_number
 and
 .Fa fts_pointer
@@ -372,6 +388,13 @@
 .Fa fts_name
 field is always
 .Dv NUL Ns -terminated .
+.Pp
+Note that the use of
+.Fa fts_bignum
+is mutually exclusive with the use of
+.Fa fts_number
+or
+.Fa fts_pointer .
 .Sh FTS_OPEN
 The
 .Fn fts_open

-- 
Peter Jeremy