SCons/Tool/as.xml

   1 <?xml version="1.0"?>
   2 <!--
   3 __COPYRIGHT__
   4
   5 This file is processed by the bin/SConsDoc.py module.
   6 See its __doc__ string for a discussion of the format.
   7 -->
   8
   9 <!DOCTYPE sconsdoc [
  10 <!ENTITY % scons SYSTEM '../../doc/scons.mod'>
  11 %scons;
  12 <!ENTITY % builders-mod SYSTEM '../../doc/generated/builders.mod'>
  13 %builders-mod;
  14 <!ENTITY % functions-mod SYSTEM '../../doc/generated/functions.mod'>
  15 %functions-mod;
  16 <!ENTITY % tools-mod SYSTEM '../../doc/generated/tools.mod'>
  17 %tools-mod;
  18 <!ENTITY % variables-mod SYSTEM '../../doc/generated/variables.mod'>
  19 %variables-mod;
  20 ]>
  21
  22 <sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0"
  23           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  24           xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">
  25
  26 <tool name="as">
  27 <summary>
  28 <para>
  29 Sets construction variables for the &as; assembler.
  30 </para>
  31 </summary>
  32 <sets>
  33 <item>AS</item>
  34 <item>ASFLAGS</item>
  35 <item>ASCOM</item>
  36 <item>ASPPFLAGS</item>
  37 <item>ASPPCOM</item>
  38 </sets>
  39 <uses>
  40 <item>CC</item>
  41 <item>CPPFLAGS</item>
  42 <item>_CPPDEFFLAGS</item>
  43 <item>_CPPINCFLAGS</item>
  44 </uses>
  45 </tool>
  46
  47 <cvar name="AS">
  48 <summary>
  49 <para>
  50 The assembler.
  51 </para>
  52 </summary>
  53 </cvar>
  54
  55 <cvar name="ASCOM">
  56 <summary>
  57 <para>
  58 The command line used to generate an object file
  59 from an assembly-language source file.
  60 </para>
  61 </summary>
  62 </cvar>
  63
  64 <cvar name="ASCOMSTR">
  65 <summary>
  66 <para>
  67 The string displayed when an object file
  68 is generated from an assembly-language source file.
  69 If this is not set, then &cv-link-ASCOM; (the command line) is displayed.
  70 </para>
  71
  72 <example_commands>
  73 env = Environment(ASCOMSTR = "Assembling $TARGET")
  74 </example_commands>
  75 </summary>
  76 </cvar>
  77
  78 <cvar name="ASFLAGS">
  79 <summary>
  80 <para>
  81 General options passed to the assembler.
  82 </para>
  83 </summary>
  84 </cvar>
  85
  86 <cvar name="ASPPCOM">
  87 <summary>
  88 <para>
  89 The command line used to assemble an assembly-language
  90 source file into an object file
  91 after first running the file through the C preprocessor.
  92 Any options specified
  93 in the &cv-link-ASFLAGS; and &cv-link-CPPFLAGS; construction variables
  94 are included on this command line.
  95 </para>
  96 </summary>
  97 </cvar>
  98
  99 <cvar name="ASPPCOMSTR">
 100 <summary>
 101 <para>
 102 The string displayed when an object file
 103 is generated from an assembly-language source file
 104 after first running the file through the C preprocessor.
 105 If this is not set, then &cv-link-ASPPCOM; (the command line) is displayed.
 106 </para>
 107
 108 <example_commands>
 109 env = Environment(ASPPCOMSTR = "Assembling $TARGET")
 110 </example_commands>
 111 </summary>
 112 </cvar>
 113
 114 <cvar name="ASPPFLAGS">
 115 <summary>
 116 <para>
 117 General options when an assembling an assembly-language
 118 source file into an object file
 119 after first running the file through the C preprocessor.
 120 The default is to use the value of &cv-link-ASFLAGS;.
 121 </para>
 122 </summary>
 123 </cvar>
 124
 125 </sconsdoc>