Mercurial > piecrust2

changeset 1076:2b2872bcff1f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: Add information about common file-system sources' configurations.
author Ludovic Chabant <ludovic@chabant.com>
date Thu, 15 Feb 2018 18:36:48 -0800
parents 1ab49e6add4f
children c53af44457b6
files docs/docs/99_reference/03_sources.md
diffstat 1 files changed, 11 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/docs/docs/99_reference/03_sources.md	Thu Feb 15 18:36:08 2018 -0800
+++ b/docs/docs/99_reference/03_sources.md	Thu Feb 15 18:36:48 2018 -0800
@@ -5,6 +5,17 @@
 
 Here are the page sources that come with PieCrust by default.
 
+> Note that all file-based sources support this common set of configuration
+> settings:
+> 
+> * `ignore`: a list of patterns that specifies files to be ignored (similar to
+>   a "_black list_").
+> * `filter`: a list of patterns that specifies files to be exclusively included
+>   (similar to a "_white list_").
+> 
+> Patterns are glob patterns by default, but if they start and end with `/`,
+> they are treated as regular expressions.
+
 
 ## Default source