style cleanup: return(a) -> return a, part 1

[oweals/busybox.git] / libbb / recursive_action.c

diff --git a/libbb/recursive_action.c b/libbb/recursive_action.c
index ddaf9b896579fcaa5db9875f4789a4014eacae24..05ff5d84fd2201b6d9ad621efcce20fb4007a95c 100644 (file)
--- a/libbb/recursive_action.c
+++ b/libbb/recursive_action.c
@@ -27,7 +27,14 @@ static int true_action(const char *fileName, struct stat *statbuf, void* userDat
        return TRUE;
 }
 
-/*
+/* fileAction return value of 0 on any file in directory will make
+ * recursive_action() return 0, but it doesn't stop directory traversal
+ * (fileAction/dirAction will be called on each file).
+ *
+ * if !depthFirst, dirAction return value of 0 (FALSE) or 2 (SKIP)
+ * prevents recursion into that directory, instead
+ * recursive_action() returns 0 (if FALSE) or 1 (if SKIP). 
+ *
  * followLinks=0/1 differs mainly in handling of links to dirs.
  * 0: lstat(statbuf). Calls fileAction on link name even if points to dir.
  * 1: stat(statbuf). Calls dirAction and optionally recurse on link to dir.