Reorder FTW_ACTIONRETVAL option list.

This commit is contained in:
Michael Kerrisk 2006-05-24 06:09:24 +00:00
parent bb3b776eef
commit 5a9673109e
1 changed files with 10 additions and 10 deletions

View File

@ -180,9 +180,13 @@ should return one of the following values:
.B FTW_CONTINUE
Instructs \fBnftw\fP() to continue normally.
.TP
.B FTW_STOP
Causes \fBnftw\fP() to return immediately with the return value
\fBFTW_STOP\fP.
.B FTW_SKIP_SIBLINGS
If \fIfn\fP() returns this value, then
siblings of the current entry will be skipped,
and processing continues in the parent.
.\" If \fBFTW_DEPTH\fP
.\" is set, the entry's parent directory is processed next (with
.\" \fIflag\fP set to \fBFTW_DP\fP).
.TP
.B FTW_SKIP_SUBTREE
If \fIfn\fP() is called with an entry that is a directory
@ -192,13 +196,9 @@ arguments to \fIfn\fP().
.BR nftw ()
continues processing with the next sibling of the directory.
.TP
.B FTW_SKIP_SIBLINGS
If \fIfn\fP() returns this value, then
siblings of the current entry will be skipped,
and processing continues in the parent.
.\" If \fBFTW_DEPTH\fP
.\" is set, the entry's parent directory is processed next (with
.\" \fIflag\fP set to \fBFTW_DP\fP).
.B FTW_STOP
Causes \fBnftw\fP() to return immediately with the return value
\fBFTW_STOP\fP.
.PP
Other return values could be associated with new actions in the future;
\fIfn\fP() should not return values other than those listed above.