From 1d53d806a603044a08e359369eec72b02ba884e3 Mon Sep 17 00:00:00 2001
From: Karen Arutyunov <karen@codesynthesis.com>
Date: Thu, 1 Jun 2017 13:53:28 +0300
Subject: Add note to path_search() description

---
 libbutl/filesystem.hxx | 4 ++++
 1 file changed, 4 insertions(+)

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&&,
-- 
cgit v1.1