scan_path(): Do not recurse into hidden directories by default

Paths that start with a period ('.') are considered hidden in the Unix world.
scan_path() should arguably not recurse into these directories by default.
This patch makes it so, and introduces the "scan-hidden-path" config variable
for overriding the new default and revert to the old behaviour (scanning _all_
directories, including hidden .directories).

Signed-off-by: Johan Herland <johan@herland.net>
Signed-off-by: Lars Hjemli <larsh@prediktor.no>

1 files changed, 8 insertions, 0 deletions

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 8e51ca5..1dc3cce 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -266,12 +266,20 @@ root-readme::
         value: none.
 
 root-title::
         Text printed as heading on the repository index page. Default value:
         "Git Repository Browser".
 
+scan-hidden-path::
+        If set to "1" and scan-path is enabled, scan-path will recurse into
+        directories whose name starts with a period ('.'). Otherwise,
+        scan-path will stay away from such directories (considered as
+        "hidden"). Note that this does not apply to the ".git" directory in
+        non-bare repos. This must be defined prior to scan-path.
+        Default value: 0. See also: scan-path.
+
 scan-path::
         A path which will be scanned for repositories. If caching is enabled,
         the result will be cached as a cgitrc include-file in the cache
         directory. If project-list has been defined prior to scan-path,
         scan-path loads only the directories listed in the file pointed to by
         project-list. Default value: none. See also: cache-scanrc-ttl,