summaryrefslogtreecommitdiff
path: root/doc/generated/variables.gen
diff options
context:
space:
mode:
authorDirk Baechle <dl9obn@darc.de>2013-10-06 17:04:19 +0200
committerDirk Baechle <dl9obn@darc.de>2013-10-06 17:04:19 +0200
commitfaf5e9f6f0b488b774db4817166220cf21d2f497 (patch)
tree94c23e47c3ed3cf73d92800d8c4de7b26bbaf71b /doc/generated/variables.gen
parenta49975c0e4a81cf6089250a4e32484afd43f6245 (diff)
downloadscons-faf5e9f6f0b488b774db4817166220cf21d2f497.tar.gz
- left-aligned all code examples in documentation
- accordingly updated the generated files, containing example output
Diffstat (limited to 'doc/generated/variables.gen')
-rw-r--r--doc/generated/variables.gen20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/generated/variables.gen b/doc/generated/variables.gen
index 18281122..b2139160 100644
--- a/doc/generated/variables.gen
+++ b/doc/generated/variables.gen
@@ -7352,6 +7352,26 @@ General options passed to the zip utility.
</para>
</listitem>
</varlistentry>
+ <varlistentry id="cv-ZIPROOT">
+ <term>ZIPROOT</term>
+ <listitem>
+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:
+<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
+env = Environment()
+env.Zip('foo.zip', 'subdir1/subdir2/file1', ZIPROOT='subdir1')
+</example_commands>
+<para xmlns="http://www.scons.org/dbxsd/v1.0">
+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>
+</listitem>
+ </varlistentry>
<varlistentry id="cv-ZIPSUFFIX">
<term>ZIPSUFFIX</term>
<listitem>