Module Name: src
Committed By: uwe
Date: Mon Oct 28 09:46:54 UTC 2024
Modified Files:
src/lib/libc/gen: fts.3
Log Message:
fts(3): use Pq for longer phrases
In PostScript output the extra breathing space that .Pq adds imrpoves
readability of parenthetical clauses.
To generate a diff of this commit:
cvs rdiff -u -r1.34 -r1.35 src/lib/libc/gen/fts.3
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/lib/libc/gen/fts.3
diff -u src/lib/libc/gen/fts.3:1.34 src/lib/libc/gen/fts.3:1.35
--- src/lib/libc/gen/fts.3:1.34 Mon Oct 28 09:33:44 2024
+++ src/lib/libc/gen/fts.3 Mon Oct 28 09:46:54 2024
@@ -1,4 +1,4 @@
-.\" $NetBSD: fts.3,v 1.34 2024/10/28 09:33:44 uwe Exp $
+.\" $NetBSD: fts.3,v 1.35 2024/10/28 09:46:54 uwe Exp $
.\"
.\" Copyright (c) 1989, 1991, 1993, 1994
.\" The Regents of the University of California. All rights reserved.
@@ -83,14 +83,17 @@ The function
returns a pointer to a linked list of structures, each of which describes
one of the files contained in a directory in the hierarchy.
In general, directories are visited two distinguishable times; in pre-order
-(before any of their descendants are visited) and in post-order (after all
-of their descendants have been visited).
+.Pq before any of their descendants are visited
+and in post-order
+.Pq after all of their descendants have been visited .
Files are visited once.
It is possible to walk the hierarchy
.Dq logically
-(ignoring symbolic links)
-or physically (visiting symbolic links), order the walk of the hierarchy or
-prune and/or re-visit portions of the hierarchy.
+.Pq ignoring symbolic links
+or physically
+.Pq visiting symbolic links ,
+order the walk of the hierarchy or prune and/or re-visit portions of
+the hierarchy.
.Pp
Two structures are defined (and typedef'd) in the include file
.In fts.h .
@@ -151,11 +154,11 @@ of their descendants be visited.
A directory being visited in pre-order.
.It Dv FTS_DC
A directory that causes a cycle in the tree.
-(The
+The
.Fa fts_cycle
field of the
.Vt FTSENT
-structure will be filled in as well).
+structure will be filled in as well.
.It Dv FTS_DEFAULT
Any
.Vt FTSENT
@@ -361,10 +364,13 @@ The array must be terminated by a
pointer.
.Pp
There are
-a number of options, at least one of which (either
+a number of options, at least one of which
+.Po
+either
.Dv FTS_LOGICAL
or
-.Dv FTS_PHYSICAL )
+.Dv FTS_PHYSICAL
+.Pc
must be specified.
The options are selected by
.Em or Ns 'ing
@@ -414,9 +420,9 @@ pathnames were provided as arguments to
.It Dv FTS_NOSTAT
By default, returned
.Vt FTSENT
-structures reference file characteristic information (the
-.Fa statp
-field) for each file visited.
+structures reference file characteristic information
+.Pq the Fa fts_statp No field
+for each file visited.
This option relaxes that requirement as a performance optimization,
allowing the
.Nm
@@ -425,7 +431,7 @@ functions to set the
field to
.Dv FTS_NSOK
and leave the contents of the
-.Fa statp
+.Fa fts_statp
field undefined.
.It Dv FTS_PHYSICAL
This option causes the
@@ -521,12 +527,15 @@ function returns a pointer to an
.Vt FTSENT
structure describing a file in
the hierarchy.
-Directories (that are readable and do not cause cycles) are visited at
-least twice, once in pre-order and once in post-order.
+Directories
+.Pq that are readable and do not cause cycles
+are visited at least twice, once in pre-order and once in post-order.
All other files are visited at least once.
-(Hard links between directories that do not cause cycles or symbolic
+.Po
+Hard links between directories that do not cause cycles or symbolic
links to symbolic links may cause files to be visited more than once,
-or directories more than twice.)
+or directories more than twice
+.Pc .
.Pp
If all the members of the hierarchy have been returned,
.Fn fts_read
@@ -666,8 +675,9 @@ This option is meaningful only for the m
file from
.Fn fts_read .
Normal use is for post-order directory visits, where it causes the
-directory to be re-visited (in both pre and post-order) as well as all
-of its descendants.
+directory to be re-visited
+.Pq in both pre- and post-order
+as well as all of its descendants.
.It Dv FTS_FOLLOW
The referenced file must be a symbolic link.
If the referenced file is the one most recently returned by
