diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/markdown/snippets/configure_file_macro_guard.md | 6 | ||||
| -rw-r--r-- | docs/yaml/functions/configure_file.yaml | 7 |
2 files changed, 13 insertions, 0 deletions
diff --git a/docs/markdown/snippets/configure_file_macro_guard.md b/docs/markdown/snippets/configure_file_macro_guard.md new file mode 100644 index 0000000..ebb4fc5 --- /dev/null +++ b/docs/markdown/snippets/configure_file_macro_guard.md @@ -0,0 +1,6 @@ +## [[configure_file]] now has a `macro_name` parameter. + +This new paramater, `macro_name` allows C macro-style include guards to be added +to [[configure_file]]'s output when a template file is not given. This change +simplifies the creation of configure files that define macros with dynamic names +and want the C-style include guards. diff --git a/docs/yaml/functions/configure_file.yaml b/docs/yaml/functions/configure_file.yaml index 6fb972b..34cb3c1 100644 --- a/docs/yaml/functions/configure_file.yaml +++ b/docs/yaml/functions/configure_file.yaml @@ -144,3 +144,10 @@ kwargs: Set the file encoding for the input and output file. The supported encodings are those of python3, see [standard-encodings](https://docs.python.org/3/library/codecs.html#standard-encodings). + + macro_name: + type: str + since: 1.3.0 + description: | + When specified, macro guards will be used instead of '#pragma once'. The + macro guard name will be the specified name. |