svn commit: r233477 - stable/8/lib/libc/gen

[Jilles Tjoelker]

Author: jilles
Date: Sun Mar 25 20:09:02 2012
New Revision: 233477
URL: http://svn.freebsd.org/changeset/base/233477

Log:
  MFC r233132: fts(3): Mention that FTS_NOCHDIR imposes {PATH_MAX} limits on
  the returned pathnames.
  
  With the current API (no *at functions), FTS_NOCHDIR requires that the
  fts_accpath start with the original path passed to fts_open(); therefore,
  the depth that can be reached is limited by the {PATH_MAX} constraint on
  this pathname.

Modified:
  stable/8/lib/libc/gen/fts.3
Directory Properties:
  stable/8/lib/libc/   (props changed)

Modified: stable/8/lib/libc/gen/fts.3
==============================================================================
--- stable/8/lib/libc/gen/fts.3	Sun Mar 25 20:07:50 2012	(r233476)
+++ stable/8/lib/libc/gen/fts.3	Sun Mar 25 20:09:02 2012	(r233477)
@@ -419,14 +419,17 @@ be provided to the
 .Fn fts_open
 function.
 .It Dv FTS_NOCHDIR
-As a performance optimization, the
+To allow descending to arbitrary depths
+(independent of
+.Brq Dv PATH_MAX )
+and improve performance, the
 .Nm
 functions change directories as they walk the file hierarchy.
 This has the side-effect that an application cannot rely on being
 in any particular directory during the traversal.
 The
 .Dv FTS_NOCHDIR
-option turns off this optimization, and the
+option turns off this feature, and the
 .Nm
 functions will not change the current directory.
 Note that applications should not themselves change their current directory