summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/zip.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/zip.xml
parentcb3425abe0bc2d05caf401ca24b82a25a81f009d (diff)
Imported Upstream version 2.3.1upstream/2.3.1
Diffstat (limited to 'src/engine/SCons/Tool/zip.xml')
-rw-r--r--src/engine/SCons/Tool/zip.xml80
1 files changed, 69 insertions, 11 deletions
diff --git a/src/engine/SCons/Tool/zip.xml b/src/engine/SCons/Tool/zip.xml
index eb557e1..644282e 100644
--- a/src/engine/SCons/Tool/zip.xml
+++ b/src/engine/SCons/Tool/zip.xml
@@ -1,27 +1,49 @@
+<?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="zip">
<summary>
+<para>
Sets construction variables for the &zip; archiver.
+</para>
</summary>
<sets>
-ZIP
-ZIPFLAGS
-ZIPCOM
-ZIPCOMPRESSION
-ZIPSUFFIX
+<item>ZIP</item>
+<item>ZIPFLAGS</item>
+<item>ZIPCOM</item>
+<item>ZIPCOMPRESSION</item>
+<item>ZIPSUFFIX</item>
</sets>
<uses>
-ZIPCOMSTR
+<item>ZIPCOMSTR</item>
</uses>
</tool>
<builder name="Zip">
<summary>
+<para>
Builds a zip archive of the specified files
and/or directories.
Unlike most builder methods,
@@ -38,47 +60,55 @@ any on-disk files,
regardless of whether or not
&scons;
knows about them from other Builder or function calls.
+</para>
-<example>
+<example_commands>
env.Zip('src.zip', 'src')
# Create the stuff.zip file.
env.Zip('stuff', ['subdir1', 'subdir2'])
# Also add "another" to the stuff.tar file.
env.Zip('stuff', 'another')
-</example>
+</example_commands>
</summary>
</builder>
<cvar name="ZIP">
<summary>
+<para>
The zip compression and file packaging utility.
+</para>
</summary>
</cvar>
<cvar name="ZIPCOM">
<summary>
+<para>
The command line used to call the zip utility,
or the internal Python function used to create a
zip archive.
+</para>
</summary>
</cvar>
<cvar name="ZIPCOMSTR">
<summary>
+<para>
The string displayed when archiving files
using the zip utility.
If this is not set, then &cv-link-ZIPCOM;
(the command line or internal Python function) is displayed.
+</para>
-<example>
+<example_commands>
env = Environment(ZIPCOMSTR = "Zipping $TARGET")
-</example>
+</example_commands>
</summary>
</cvar>
<cvar name="ZIPCOMPRESSION">
<summary>
+<para>
The
<varname>compression</varname>
flag
@@ -93,17 +123,45 @@ which creates a compressed zip archive.
This value has no effect if the
<literal>zipfile</literal>
module is unavailable.
+</para>
</summary>
</cvar>
<cvar name="ZIPFLAGS">
<summary>
+<para>
General options passed to the zip utility.
+</para>
</summary>
</cvar>
<cvar name="ZIPSUFFIX">
<summary>
+<para>
The suffix used for zip file names.
+</para>
+</summary>
+</cvar>
+
+<cvar name="ZIPROOT">
+<summary>
+<para>
+An optional zip root directory (default empty). The filenames stored
+in the zip file will be relative to this directory, if given.
+Otherwise the filenames are relative to the current directory of the
+command.
+For instance:
+</para>
+<example_commands>
+env = Environment()
+env.Zip('foo.zip', 'subdir1/subdir2/file1', ZIPROOT='subdir1')
+</example_commands>
+<para>
+will produce a zip file <literal>foo.zip</literal>
+containing a file with the name
+<literal>subdir2/file1</literal> rather than
+<literal>subdir1/subdir2/file1</literal>.
+</para>
</summary>
</cvar>
+</sconsdoc>