summaryrefslogtreecommitdiffstats
path: root/src/engine/SCons/Tool/packaging.xml
diff options
context:
space:
mode:
authorDirk Baechle <dl9obn@darc.de>2013-05-03 22:05:51 (GMT)
committerDirk Baechle <dl9obn@darc.de>2013-05-03 22:05:51 (GMT)
commit4b84b4db45741fa0a0aff1753b08216e9434fcbe (patch)
tree174928381514e32e0735a6f5cad854cc315b4904 /src/engine/SCons/Tool/packaging.xml
parenta0e23f824f8865cb1d3eb7808a3107c7864b579a (diff)
downloadSCons-4b84b4db45741fa0a0aff1753b08216e9434fcbe.zip
SCons-4b84b4db45741fa0a0aff1753b08216e9434fcbe.tar.gz
SCons-4b84b4db45741fa0a0aff1753b08216e9434fcbe.tar.bz2
- rewrote all tool/builder docs to new SCons XSD
Diffstat (limited to 'src/engine/SCons/Tool/packaging.xml')
-rw-r--r--src/engine/SCons/Tool/packaging.xml45
1 files changed, 41 insertions, 4 deletions
diff --git a/src/engine/SCons/Tool/packaging.xml b/src/engine/SCons/Tool/packaging.xml
index e2d0fb4..38efdce 100644
--- a/src/engine/SCons/Tool/packaging.xml
+++ b/src/engine/SCons/Tool/packaging.xml
@@ -1,73 +1,110 @@
+<?xml version="1.0" encoding="UTF-8"?>
<!--
__COPYRIGHT__
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">
+
<tool name="packaging">
<summary>
+<para>
A framework for building binary and source packages.
+</para>
</summary>
</tool>
<builder name="Package">
<summary>
+<para>
Builds a Binary Package of the given source files.
+</para>
-<example>
+<example_commands>
env.Package(source = FindInstalledFiles())
-</example>
+</example_commands>
</summary>
</builder>
<cvar name="JAR">
<summary>
+<para>
The Java archive tool.
+</para>
</summary>
</cvar>
<cvar name="JARCHDIR">
<summary>
+<para>
The directory to which the Java archive tool should change
(using the
<option>-C</option>
option).
+</para>
</summary>
</cvar>
<cvar name="JARCOM">
<summary>
+<para>
The command line used to call the Java archive tool.
+</para>
</summary>
</cvar>
<cvar name="JARCOMSTR">
<summary>
+<para>
The string displayed when the Java archive tool
is called
If this is not set, then &cv-JARCOM; (the command line) is displayed.
+</para>
-<example>
+<example_commands>
env = Environment(JARCOMSTR = "JARchiving $SOURCES into $TARGET")
-</example>
+</example_commands>
</summary>
</cvar>
<cvar name="JARFLAGS">
<summary>
+<para>
General options passed to the Java archive tool.
By default this is set to
<option>cf</option>
to create the necessary
<command>jar</command>
file.
+</para>
</summary>
</cvar>
<cvar name="JARSUFFIX">
<summary>
+<para>
The suffix for Java archives:
<filename>.jar</filename>
by default.
+</para>
</summary>
</cvar>
+
+</sconsdoc> \ No newline at end of file