summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/zip.xml
diff options
context:
space:
mode:
authorGary Oberbrunner <garyo@oberbrunner.com>2013-05-04 16:28:50 -0400
committerGary Oberbrunner <garyo@oberbrunner.com>2013-05-04 16:28:50 -0400
commitcc7ac69ca8331dd77fef8ac334bed0c1ad42e4a2 (patch)
tree9140cb365149a3397726b85feb8f73de851cf16e /src/engine/SCons/Tool/zip.xml
parent8e70741f93305f5b28bd3f77954f615aa0fcf840 (diff)
downloadscons-cc7ac69ca8331dd77fef8ac334bed0c1ad42e4a2.tar.gz
New doc toolchain changes:
bin/SConsDoc.py: catch parse exceptions and improve error msgs bin/docs-validate.py: allow testing individual files from cmd line src/engine/SCons/Tool/zip.xml: fix text to validate against DTD
Diffstat (limited to 'src/engine/SCons/Tool/zip.xml')
-rw-r--r--src/engine/SCons/Tool/zip.xml8
1 files changed, 5 insertions, 3 deletions
diff --git a/src/engine/SCons/Tool/zip.xml b/src/engine/SCons/Tool/zip.xml
index 3d7cb24c..af685332 100644
--- a/src/engine/SCons/Tool/zip.xml
+++ b/src/engine/SCons/Tool/zip.xml
@@ -143,7 +143,6 @@ The suffix used for zip file names.
</summary>
</cvar>
-</sconsdoc>
<cvar name="ZIPROOT">
<summary>
An optional zip root directory (default empty). The filenames stored
@@ -151,13 +150,16 @@ 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>
+<example_commands>
env = Environment()
env.Zip('foo.zip', 'subdir1/subdir2/file1', ZIPROOT='subdir1')
-</example>
+</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>