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.

MFC after:	1 week
This commit is contained in:
Jilles Tjoelker 2012-03-18 21:46:27 +00:00
parent fde89290d1
commit 012df2856c
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=233132

View File

@ -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