summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/m4.xml
blob: f7e81e5b85781087dc6e9b45b84561cb900cd258 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2001 - 2019 The SCons Foundation

This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
-->

<!DOCTYPE sconsdoc [
<!ENTITY % scons SYSTEM '../../../../doc/scons.mod'>
%scons;
<!ENTITY % builders-mod SYSTEM '../../../../doc/generated/builders.mod'>
%builders-mod;
<!ENTITY % functions-mod SYSTEM '../../../../doc/generated/functions.mod'>
%functions-mod;
<!ENTITY % tools-mod SYSTEM '../../../../doc/generated/tools.mod'>
%tools-mod;
<!ENTITY % variables-mod SYSTEM '../../../../doc/generated/variables.mod'>
%variables-mod;
]>

<sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">

<tool name="m4">
<summary>
<para>
Sets construction variables for the &m4; macro processor.
</para>
</summary>
<sets>
<item>M4</item>
<item>M4FLAGS</item>
<item>M4COM</item>
</sets>
<uses>
<item>M4COMSTR</item>
</uses>
</tool>

<builder name="M4">
<summary>
<para>
Builds an output file from an M4 input file.
This uses a default &cv-link-M4FLAGS; value of
<option>-E</option>,
which considers all warnings to be fatal
and stops on the first warning
when using the GNU version of m4.
Example:
</para>

<example_commands>
env.M4(target = 'foo.c', source = 'foo.c.m4')
</example_commands>
</summary>
</builder>

<cvar name="M4">
<summary>
<para>
The M4 macro preprocessor.
</para>
</summary>
</cvar>

<cvar name="M4COM">
<summary>
<para>
The command line used to pass files through the M4 macro preprocessor.
</para>
</summary>
</cvar>

<cvar name="M4COMSTR">
<summary>
<para>
The string displayed when
a file is passed through the M4 macro preprocessor.
If this is not set, then &cv-link-M4COM; (the command line) is displayed.
</para>
</summary>
</cvar>

<cvar name="M4FLAGS">
<summary>
<para>
General options passed to the M4 macro preprocessor.
</para>
</summary>
</cvar>

</sconsdoc>