summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDave Henderson <dhenderson@gmail.com>2022-03-10 19:01:45 -0500
committerDave Henderson <dhenderson@gmail.com>2022-03-10 20:26:23 -0500
commit69cd0faccb0f49838670c6fb5437df7a3b834f4c (patch)
tree89622331365305bfa03e8818dcda241c76c123fb /docs
parentcf1f21584ad30b76b67e2d0b5ad8a3afd2f93512 (diff)
Clarify that inputDir is read recursively
Signed-off-by: Dave Henderson <dhenderson@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/content/config.md5
-rw-r--r--docs/content/usage.md2
2 files changed, 4 insertions, 3 deletions
diff --git a/docs/content/config.md b/docs/content/config.md
index c88ce025..01a21324 100644
--- a/docs/content/config.md
+++ b/docs/content/config.md
@@ -190,8 +190,9 @@ May not be used with `inputDir` or `inputFiles`.
See [`--input-dir`](../usage/#input-dir-and-output-dir).
-The directory containing input template files. Must be used with
-[`outputDir`](#outputdir) or [`outputMap`](#outputmap). Can also be used with [`excludes`](#excludes).
+The directory containing input template files. All files contained within will
+be processed recursively. Must be used with [`outputDir`](#outputdir) or
+[`outputMap`](#outputmap). Can also be used with [`excludes`](#excludes).
```yaml
inputDir: templates/
diff --git a/docs/content/usage.md b/docs/content/usage.md
index b4af259e..e51181bd 100644
--- a/docs/content/usage.md
+++ b/docs/content/usage.md
@@ -50,7 +50,7 @@ You can specify multiple `--file` and `--out` arguments. The same number of each
### `--input-dir` and `--output-dir`
-For processing multiple templates in a directory you can use `--input-dir` and `--output-dir` together. In this case all files in input directory will be processed as templates and the resulting files stored in `--output-dir`. The output directory will be created if it does not exist and the directory structure of the input directory will be preserved.
+For processing multiple templates in a directory you can use `--input-dir` and `--output-dir` together. In this case all files in input directory will be processed recursively as templates and the resulting files stored in `--output-dir`. The output directory will be created if it does not exist and the directory structure of the input directory will be preserved.
You can use the [`--exclude`](#exclude) argument and/or a [`.gomplateignore`](#ignorefile) file to exclude some of the files in the input directory.