Add advice about scan-path in cgitrc.5.txt

Signed-off-by: Julius Plenz <plenz@cis.fu-berlin.de>
Signed-off-by: Lars Hjemli <hjemli@gmail.com>

1 files changed, 3 insertions, 2 deletions

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index be8483c..65b210f 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -242,98 +242,99 @@ project-list::
 readme::
 	Text which will be used as default value for "repo.readme". Default
 	value: none.
 
 remove-suffix::
 	If set to "1" and scan-path is enabled, if any repositories are found
 	with a suffix of ".git", this suffix will be removed for the url and
 	name. Default value: "0". See also: scan-path.
 
 renamelimit::
 	Maximum number of files to consider when detecting renames. The value
 	 "-1" uses the compiletime value in git (for further info, look at
 	  `man git-diff`). Default value: "-1".
 
 repo.group::
 	Legacy alias for "section". This option is deprecated and will not be
 	supported in cgit-1.0.
 
 robots::
 	Text used as content for the "robots" meta-tag. Default value:
 	"index, nofollow".
 
 root-desc::
 	Text printed below the heading on the repository index page. Default
 	value: "a fast webinterface for the git dscm".
 
 root-readme::
 	The content of the file specified with this option will be included
 	verbatim below the "about" link on the repository index page. Default
 	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,
-	project-list.
+	project-list. Be advised that only the global settings taken
+	before the scan-path directive will be applied to each repository.
+	Default value: none. See also: cache-scanrc-ttl, project-list.
 
 section::
 	The name of the current repository section - all repositories defined
 	after this option will inherit the current section name. Default value:
 	none.
 
 section-from-path::
 	A number which, if specified before scan-path, specifies how many
 	path elements from each repo path to use as a default section name.
 	If negative, cgit will discard the specified number of path elements
 	above the repo directory. Default value: 0.
 
 side-by-side-diffs::
 	If set to "1" shows side-by-side diffs instead of unidiffs per
 	default. Default value: "0".
 
 snapshots::
 	Text which specifies the default set of snapshot formats generated by
 	cgit. The value is a space-separated list of zero or more of the
 	values "tar", "tar.gz", "tar.bz2", "tar.xz" and "zip". Default value:
 	none.
 
 source-filter::
 	Specifies a command which will be invoked to format plaintext blobs
 	in the tree view. The command will get the blob content on its STDIN
 	and the name of the blob as its only command line argument. The STDOUT
 	from the command will be included verbatim as the blob contents, i.e.
 	this can be used to implement e.g. syntax highlighting. Default value:
 	none.
 
 summary-branches::
 	Specifies the number of branches to display in the repository "summary"
 	view. Default value: "10".
 
 summary-log::
 	Specifies the number of log entries to display in the repository
 	"summary" view. Default value: "10".
 
 summary-tags::
 	Specifies the number of tags to display in the repository "summary"
 	view. Default value: "10".
 
 strict-export::
 	Filename which, if specified, needs to be present within the repository
 	for cgit to allow access to that repository. This can be used to emulate
 	gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's
 	repositories to match those exported by git-daemon. This option MUST come
 	before 'scan-path'.