summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/applelink.xml
diff options
context:
space:
mode:
authorLuca Falavigna <dktrkranz@debian.org>2014-04-26 15:11:58 +0200
committerLuca Falavigna <dktrkranz@debian.org>2014-04-26 15:11:58 +0200
commit140d836e9cd54fb67b969fd82ef7ed19ba574d40 (patch)
tree0df3e32ee39603d43f9b90fd2f2e1f7cce4249d4 /src/engine/SCons/Tool/applelink.xml
parentcb3425abe0bc2d05caf401ca24b82a25a81f009d (diff)
Imported Upstream version 2.3.1upstream/2.3.1
Diffstat (limited to 'src/engine/SCons/Tool/applelink.xml')
-rw-r--r--src/engine/SCons/Tool/applelink.xml77
1 files changed, 59 insertions, 18 deletions
diff --git a/src/engine/SCons/Tool/applelink.xml b/src/engine/SCons/Tool/applelink.xml
index 3687d8c..f3f1a2d 100644
--- a/src/engine/SCons/Tool/applelink.xml
+++ b/src/engine/SCons/Tool/applelink.xml
@@ -1,33 +1,55 @@
+<?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="applelink">
<summary>
+<para>
Sets construction variables for the Apple linker
(similar to the GNU linker).
+</para>
</summary>
<sets>
-FRAMEWORKPATHPREFIX
-_FRAMEWORKPATH
-_FRAMEWORKS
-LINKCOM
-SHLINKFLAGS
-SHLINKCOM
-LDMODULEPREFIX
-LDMODULESUFFIX
-LDMODULEFLAGS
-LDMODULECOM
+<item>FRAMEWORKPATHPREFIX</item>
+<item>_FRAMEWORKPATH</item>
+<item>_FRAMEWORKS</item>
+<item>LINKCOM</item>
+<item>SHLINKFLAGS</item>
+<item>SHLINKCOM</item>
+<item>LDMODULEPREFIX</item>
+<item>LDMODULESUFFIX</item>
+<item>LDMODULEFLAGS</item>
+<item>LDMODULECOM</item>
</sets>
<uses>
-FRAMEWORKSFLAGS
+<item>FRAMEWORKSFLAGS</item>
</uses>
</tool>
<cvar name="FRAMEWORKSFLAGS">">
<summary>
+<para>
On Mac OS X with gcc,
general user-supplied frameworks options to be added at
the end of a command
@@ -36,44 +58,52 @@ line building a loadable module.
the &cv-link-FRAMEWORKPATH;, &cv-link-FRAMEWORKPATHPREFIX;,
&cv-link-FRAMEWORKPREFIX; and &cv-link-FRAMEWORKS; variables
described above.)
+</para>
</summary>
</cvar>
<cvar name="FRAMEWORKS">
<summary>
+<para>
On Mac OS X with gcc, a list of the framework names to be linked into a
program or shared library or bundle.
The default value is the empty list.
For example:
+</para>
-<example>
+<example_commands>
env.AppendUnique(FRAMEWORKS=Split('System Cocoa SystemConfiguration'))
-</example>
+</example_commands>
</summary>
</cvar>
<cvar name="FRAMEWORKPREFIX">
<summary>
+<para>
On Mac OS X with gcc,
the prefix to be used for linking in frameworks
(see &cv-link-FRAMEWORKS;).
The default value is
<option>-framework</option>.
+</para>
</summary>
</cvar>
<cvar name="_FRAMEWORKS">
<summary>
+<para>
On Mac OS X with gcc,
an automatically-generated construction variable
containing the linker command-line options
for linking with FRAMEWORKS.
+</para>
</summary>
</cvar>
<cvar name="FRAMEWORKPATH">
<summary>
+<para>
On Mac OS X with gcc,
a list containing the paths to search for frameworks.
Used by the compiler to find framework-style includes like
@@ -81,34 +111,45 @@ Used by the compiler to find framework-style includes like
Used by the linker to find user-specified frameworks when linking (see
&cv-link-FRAMEWORKS;).
For example:
+</para>
-<example>
+<example_commands>
env.AppendUnique(FRAMEWORKPATH='#myframeworkdir')
-</example>
+</example_commands>
+<para>
will add
+</para>
-<example>
+<example_commands>
... -Fmyframeworkdir
-</example>
+</example_commands>
+<para>
to the compiler and linker command lines.
+</para>
</summary>
</cvar>
<cvar name="FRAMEWORKPATHPREFIX">
<summary>
+<para>
On Mac OS X with gcc, the prefix to be used for the FRAMEWORKPATH entries.
(see &cv-link-FRAMEWORKPATH;).
The default value is
<option>-F</option>.
+</para>
</summary>
</cvar>
<cvar name="_FRAMEWORKPATH">
<summary>
+<para>
On Mac OS X with gcc, an automatically-generated construction variable
containing the linker command-line options corresponding to
&cv-link-FRAMEWORKPATH;.
+</para>
</summary>
</cvar>
+
+</sconsdoc> \ No newline at end of file