From 69cd0faccb0f49838670c6fb5437df7a3b834f4c Mon Sep 17 00:00:00 2001 From: Dave Henderson Date: Thu, 10 Mar 2022 19:01:45 -0500 Subject: [PATCH] Clarify that inputDir is read recursively Signed-off-by: Dave Henderson --- docs/content/config.md | 5 +++-- docs/content/usage.md | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/content/config.md b/docs/content/config.md index c88ce0251..01a213246 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 b4af259e8..e51181bd2 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.