summaryrefslogtreecommitdiffstats
path: root/src/engine/SCons/Tool/zip.xml
diff options
context:
space:
mode:
authorGary Oberbrunner <garyo@oberbrunner.com>2013-04-20 17:03:01 (GMT)
committerGary Oberbrunner <garyo@oberbrunner.com>2013-04-20 17:03:01 (GMT)
commit8a1a4804a56a469c32aaa1c3b1310383b3befa54 (patch)
treed431ed534dade001ab1f057275130bbdd45e7c9d /src/engine/SCons/Tool/zip.xml
parent1411faab72ab26f640bdaa145ffc3510669941bd (diff)
downloadSCons-8a1a4804a56a469c32aaa1c3b1310383b3befa54.zip
SCons-8a1a4804a56a469c32aaa1c3b1310383b3befa54.tar.gz
SCons-8a1a4804a56a469c32aaa1c3b1310383b3befa54.tar.bz2
Added tests for ZIPROOT, and tweaked the ZIPROOT doc a bit.
Also cleaned up the ZIP tests by assuming that python has the zipfile module, which has been true since python 1.6.
Diffstat (limited to 'src/engine/SCons/Tool/zip.xml')
-rw-r--r--src/engine/SCons/Tool/zip.xml14
1 files changed, 13 insertions, 1 deletions
diff --git a/src/engine/SCons/Tool/zip.xml b/src/engine/SCons/Tool/zip.xml
index 85b3d52..c2b8026 100644
--- a/src/engine/SCons/Tool/zip.xml
+++ b/src/engine/SCons/Tool/zip.xml
@@ -110,6 +110,18 @@ The suffix used for zip file names.
<cvar name="ZIPROOT">
<summary>
-An optional zip root directory (default empty).
+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>
+env = Environment()
+env.Zip('foo.zip', 'subdir1/subdir2/file1', ZIPROOT='subdir1')
+</example>
+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>.
</summary>
</cvar>