diff options
Diffstat (limited to 'src/engine/SCons/Tool/jar.xml')
| -rw-r--r-- | src/engine/SCons/Tool/jar.xml | 61 |
1 files changed, 51 insertions, 10 deletions
diff --git a/src/engine/SCons/Tool/jar.xml b/src/engine/SCons/Tool/jar.xml index fc94f12..fedaf51 100644 --- a/src/engine/SCons/Tool/jar.xml +++ b/src/engine/SCons/Tool/jar.xml @@ -1,26 +1,48 @@ +<?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="jar"> <summary> +<para> Sets construction variables for the &jar; utility. +</para> </summary> <sets> -JAR -JARFLAGS -JARCOM -JARSUFFIX +<item>JAR</item> +<item>JARFLAGS</item> +<item>JARCOM</item> +<item>JARSUFFIX</item> </sets> <uses> -JARCOMSTR +<item>JARCOMSTR</item> </uses> </tool> <builder name="Jar"> <summary> +<para> Builds a Java archive (<filename>.jar</filename>) file from the specified list of sources. Any directories in the source list @@ -28,7 +50,9 @@ will be searched for <filename>.class</filename> files). Any <filename>.java</filename> files in the source list will be compiled to <filename>.class</filename> files by calling the &b-link-Java; Builder. +</para> +<para> If the &cv-link-JARCHDIR; value is set, the &jar; command will change to the specified directory using the @@ -38,7 +62,9 @@ If &cv-JARCHDIR; is not set explicitly, &SCons; will use the top of any subdirectory tree in which Java <filename>.class</filename> were built by the &b-link-Java; Builder. +</para> +<para> If the contents any of the source files begin with the string <literal>Manifest-Version</literal>, the file is assumed to be a manifest @@ -47,64 +73,79 @@ and is passed to the command with the <option>m</option> option set. +</para> -<example> +<example_commands> env.Jar(target = 'foo.jar', source = 'classes') env.Jar(target = 'bar.jar', source = ['bar1.java', 'bar2.java']) -</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-link-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 |