SCons/Tool/as.xml

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