1. Steve Losh
  2. blatter

Commits

Steve Losh  committed 6013d36

Add documentation for the ignore feature.

  • Participants
  • Parent commits a34c60c
  • Branches default

Comments (0)

Files changed (2)

File README

View file
+-*- restructuredtext -*-
+
 =======
 blatter
 =======
   [fallback.root_website]
   location=../root_website
 
+Ignoring Files
+--------------
+
+Files can be ignored by creating a file named ``ignore`` in the same location as ``blatter.ini``.  The file should consist of one file/directory name per line.  No wildcards are supported.  The ignore applies recursively.  For example, if you have an ignore file like:
+
+  index.html
+
+then ALL of the following would be ignored:
+
+  /static/index.html
+  /static/dir/index.html
+  /site/index.html
+  /site/dir/sub/dir/index.html
+
+This feature should be considered extremely experimental.  It works well for excluding a ``.hg`` or ``CVS`` directory if you keep your content under version control but probably isn't good for much else yet.
+
+
 Author
 ------
 

File blatter/__init__.py

View file
 #[fallback.other_blatter]
 #location=../other_blatter
 
+# Files can be ignored by creating a file named 'ignore' in the same location
+# as blatter.ini.  The file should consist of one file/directory name per
+# line.  No wildcards are supported.  The ignore applies recursively, for
+# example, if you have an ignore file like:
+# 
+# index.html
+#
+# then ALL of the following would be ignored:
+#
+# /static/index.html
+# /static/dir/index.html
+# /site/index.html
+# /site/dir/sub/dir/index.html
+#
+# This feature should be considered extremely experimental.  It works well for
+# excluding a '.hg' or '.git' directory if you keep your content under version
+# control but probably isn't good for much else.
 """
 
 sample_data = (