aboutsummaryrefslogtreecommitdiff
path: root/docs/yaml/objects/compiler.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/yaml/objects/compiler.yaml')
-rw-r--r--docs/yaml/objects/compiler.yaml22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/yaml/objects/compiler.yaml b/docs/yaml/objects/compiler.yaml
index 6f49ec5..f6743ad 100644
--- a/docs/yaml/objects/compiler.yaml
+++ b/docs/yaml/objects/compiler.yaml
@@ -586,3 +586,25 @@ methods:
gcc or msvc, but use the same argument syntax as one of those two compilers
such as clang or icc, especially when they use different syntax on different
operating systems.
+
+- name: preprocess
+ returns: list[custom_idx]
+ since: 0.64.0
+ description: |
+ Preprocess a list of source files but do not compile them. The preprocessor
+ will receive the same arguments (include directories, defines, etc) as with
+ normal compilation. That includes for example args added with
+ `add_project_arguments()`, or on the command line with `-Dc_args=-DFOO`.
+ varargs_inherit: _build_target_base
+ kwargs:
+ output:
+ type: str
+ description: |
+ Template for name of preprocessed files: `@PLAINNAME@` is replaced by
+ the source filename and `@BASENAME@` is replaced by the source filename
+ without its extension.
+ compile_args:
+ type: list[str]
+ description: |
+ Extra flags to pass to the preprocessor
+