aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKaren Arutyunov <karen@codesynthesis.com>2017-06-01 13:53:28 +0300
committerKaren Arutyunov <karen@codesynthesis.com>2017-06-01 13:53:28 +0300
commit1d53d806a603044a08e359369eec72b02ba884e3 (patch)
tree4f9edb5dc84c4372079a74056f2ba3e06cdbdcdb
parent4e28e9df3c08af96bf6639c6f90e09819eb9a90f (diff)
Add note to path_search() description
-rw-r--r--libbutl/filesystem.hxx4
1 files changed, 4 insertions, 0 deletions
diff --git a/libbutl/filesystem.hxx b/libbutl/filesystem.hxx
index a6d7a4a..6ea7d2c 100644
--- a/libbutl/filesystem.hxx
+++ b/libbutl/filesystem.hxx
@@ -567,6 +567,10 @@ namespace butl
// (a/b/, b*/, true)
// (a/b/c/, c*/, false)
//
+ // Note that recursive iterating through directories currently goes
+ // depth-first which make sense for the cleanup use cases. In future we may
+ // want to make it controllable.
+ //
LIBBUTL_EXPORT void
path_search (const path& pattern,
const std::function<bool (path&&,