summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/as.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/engine/SCons/Tool/as.xml')
-rw-r--r--src/engine/SCons/Tool/as.xml65
1 files changed, 51 insertions, 14 deletions
diff --git a/src/engine/SCons/Tool/as.xml b/src/engine/SCons/Tool/as.xml
index 1e0d451..70fc036 100644
--- a/src/engine/SCons/Tool/as.xml
+++ b/src/engine/SCons/Tool/as.xml
@@ -1,88 +1,125 @@
+<?xml version="1.0" encoding="UTF-8"?>
<!--
-Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The SCons Foundation
+Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 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/scons.xsd scons.xsd">
+
<tool name="as">
<summary>
+<para>
Sets construction variables for the &as; assembler.
+</para>
</summary>
<sets>
-AS
-ASFLAGS
-ASCOM
-ASPPFLAGS
-ASPPCOM
+<item>AS</item>
+<item>ASFLAGS</item>
+<item>ASCOM</item>
+<item>ASPPFLAGS</item>
+<item>ASPPCOM</item>
</sets>
<uses>
-CC
-CPPFLAGS
-_CPPDEFFLAGS
-_CPPINCFLAGS
+<item>CC</item>
+<item>CPPFLAGS</item>
+<item>_CPPDEFFLAGS</item>
+<item>_CPPINCFLAGS</item>
</uses>
</tool>
<cvar name="AS">
<summary>
+<para>
The assembler.
+</para>
</summary>
</cvar>
<cvar name="ASCOM">
<summary>
+<para>
The command line used to generate an object file
from an assembly-language source file.
+</para>
</summary>
</cvar>
<cvar name="ASCOMSTR">
<summary>
+<para>
The string displayed when an object file
is generated from an assembly-language source file.
If this is not set, then &cv-link-ASCOM; (the command line) is displayed.
+</para>
-<example>
+<example_commands>
env = Environment(ASCOMSTR = "Assembling $TARGET")
-</example>
+</example_commands>
</summary>
</cvar>
<cvar name="ASFLAGS">
<summary>
+<para>
General options passed to the assembler.
+</para>
</summary>
</cvar>
<cvar name="ASPPCOM">
<summary>
+<para>
The command line used to assemble an assembly-language
source file into an object file
after first running the file through the C preprocessor.
Any options specified
in the &cv-link-ASFLAGS; and &cv-link-CPPFLAGS; construction variables
are included on this command line.
+</para>
</summary>
</cvar>
<cvar name="ASPPCOMSTR">
<summary>
+<para>
The string displayed when an object file
is generated from an assembly-language source file
after first running the file through the C preprocessor.
If this is not set, then &cv-link-ASPPCOM; (the command line) is displayed.
+</para>
-<example>
+<example_commands>
env = Environment(ASPPCOMSTR = "Assembling $TARGET")
-</example>
+</example_commands>
</summary>
</cvar>
<cvar name="ASPPFLAGS">
<summary>
+<para>
General options when an assembling an assembly-language
source file into an object file
after first running the file through the C preprocessor.
The default is to use the value of &cv-link-ASFLAGS;.
+</para>
</summary>
</cvar>
+
+</sconsdoc> \ No newline at end of file