src/engine/SCons/Tool/m4.xml

   1 <!--
   2 __COPYRIGHT__
   3
   4 This file is processed by the bin/SConsDoc.py module.
   5 See its __doc__ string for a discussion of the format.
   6 -->
   7 <tool name="m4">
   8 <summary>
   9 Sets construction variables for the &m4; macro processor.
  10 </summary>
  11 <sets>
  12 M4
  13 M4FLAGS
  14 M4COM
  15 </sets>
  16 <uses>
  17 M4COMSTR
  18 </uses>
  19 </tool>
  20
  21 <builder name="M4">
  22 <summary>
  23 Builds an output file from an M4 input file.
  24 This uses a default &cv-link-M4FLAGS; value of
  25 <option>-E</option>,
  26 which considers all warnings to be fatal
  27 and stops on the first warning
  28 when using the GNU version of m4.
  29 Example:
  30
  31 <example>
  32 env.M4(target = 'foo.c', source = 'foo.c.m4')
  33 </example>
  34 </summary>
  35 </builder>
  36
  37 <cvar name="M4">
  38 <summary>
  39 The M4 macro preprocessor.
  40 </summary>
  41 </cvar>
  42
  43 <cvar name="M4COM">
  44 <summary>
  45 The command line used to pass files through the M4 macro preprocessor.
  46 </summary>
  47 </cvar>
  48
  49 <cvar name="M4COMSTR">
  50 <summary>
  51 The string displayed when
  52 a file is passed through the M4 macro preprocessor.
  53 If this is not set, then &cv-link-M4COM; (the command line) is displayed.
  54 </summary>
  55 </cvar>
  56
  57 <cvar name="M4FLAGS">
  58 <summary>
  59 General options passed to the M4 macro preprocessor.
  60 </summary>
  61 </cvar>