summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlexandre Conrad <alexandre.conrad@gmail.com>2015-08-24 20:42:26 -0700
committerSteve Piercy <web@stevepiercy.com>2015-08-24 21:03:39 -0700
commitbb494a32d77b4f36473bece91cfaf8cf17c4bc07 (patch)
treeb56134beceaa99dc7dd5020de9b6fcf1dcdf2f84 /docs
parent4581a1abf6907d8c41672840f7bb282d215fa82f (diff)
downloadpyramid-bb494a32d77b4f36473bece91cfaf8cf17c4bc07.tar.gz
pyramid-bb494a32d77b4f36473bece91cfaf8cf17c4bc07.tar.bz2
pyramid-bb494a32d77b4f36473bece91cfaf8cf17c4bc07.zip
document +dot+ for dotfiles in scaffolds
Diffstat (limited to 'docs')
-rw-r--r--docs/narr/scaffolding.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/narr/scaffolding.rst b/docs/narr/scaffolding.rst
index f924d0d62..4fcdeb537 100644
--- a/docs/narr/scaffolding.rst
+++ b/docs/narr/scaffolding.rst
@@ -57,6 +57,11 @@ As you create files and directories within the template directory, note that:
have that string replaced with the value of the ``var`` variable provided
to the scaffold.
+- Files that start with a dot (e.g., ``.env``) are ignored and will not be
+ copied over to the destination directory. If you want to include a file with
+ a leading dot then you must replace the dot with ``+dot+`` (e.g.,
+ ``+dot+env``).
+
Otherwise, files and directories which live in the template directory will be
copied directly without modification to the ``pcreate`` output location.