summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/ar.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/engine/SCons/Tool/ar.xml')
-rw-r--r--src/engine/SCons/Tool/ar.xml65
1 files changed, 52 insertions, 13 deletions
diff --git a/src/engine/SCons/Tool/ar.xml b/src/engine/SCons/Tool/ar.xml
index 8d0a096..6c307d1 100644
--- a/src/engine/SCons/Tool/ar.xml
+++ b/src/engine/SCons/Tool/ar.xml
@@ -1,22 +1,43 @@
+<?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="ar">
<summary>
+<para>
Sets construction variables for the &ar; library archiver.
+</para>
</summary>
<sets>
-AR
-ARFLAGS
-ARCOM
-LIBPREFIX
-LIBSUFFIX
-RANLIB
-RANLIBFLAGS
-RANLIBCOM
+<item>AR</item>
+<item>ARFLAGS</item>
+<item>ARCOM</item>
+<item>LIBPREFIX</item>
+<item>LIBSUFFIX</item>
+<item>RANLIB</item>
+<item>RANLIBFLAGS</item>
+<item>RANLIBCOM</item>
</sets>
<uses>
</uses>
@@ -24,59 +45,77 @@ RANLIBCOM
<cvar name="AR">
<summary>
+<para>
The static library archiver.
+</para>
</summary>
</cvar>
<cvar name="ARCOM">
<summary>
+<para>
The command line used to generate a static library from object files.
+</para>
</summary>
</cvar>
<cvar name="ARCOMSTR">
<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-ARCOM; (the command line) is displayed.
+</para>
-<example>
+<example_commands>
env = Environment(ARCOMSTR = "Archiving $TARGET")
-</example>
+</example_commands>
</summary>
</cvar>
<cvar name="ARFLAGS">
<summary>
+<para>
General options passed to the static library archiver.
+</para>
</summary>
</cvar>
<cvar name="RANLIB">
<summary>
+<para>
The archive indexer.
+</para>
</summary>
</cvar>
<cvar name="RANLIBCOM">
<summary>
+<para>
The command line used to index a static library archive.
+</para>
</summary>
</cvar>
<cvar name="RANLIBCOMSTR">
<summary>
+<para>
The string displayed when a static library archive is indexed.
If this is not set, then &cv-link-RANLIBCOM; (the command line) is displayed.
+</para>
-<example>
+<example_commands>
env = Environment(RANLIBCOMSTR = "Indexing $TARGET")
-</example>
+</example_commands>
</summary>
</cvar>
<cvar name="RANLIBFLAGS">
<summary>
+<para>
General options passed to the archive indexer.
+</para>
</summary>
</cvar>
+
+</sconsdoc> \ No newline at end of file