summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/tar.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/engine/SCons/Tool/tar.xml')
-rw-r--r--src/engine/SCons/Tool/tar.xml55
1 files changed, 45 insertions, 10 deletions
diff --git a/src/engine/SCons/Tool/tar.xml b/src/engine/SCons/Tool/tar.xml
index 07ef44c..28ed5d8 100644
--- a/src/engine/SCons/Tool/tar.xml
+++ b/src/engine/SCons/Tool/tar.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="tar">
<summary>
+<para>
Sets construction variables for the &tar; archiver.
+</para>
</summary>
<sets>
-TAR
-TARFLAGS
-TARCOM
-TARSUFFIX
+<item>TAR</item>
+<item>TARFLAGS</item>
+<item>TARCOM</item>
+<item>TARSUFFIX</item>
</sets>
<uses>
-TARCOMSTR
+<item>TARCOMSTR</item>
</uses>
</tool>
<builder name="Tar">
<summary>
+<para>
Builds a tar archive of the specified files
and/or directories.
Unlike most builder methods,
@@ -37,8 +59,9 @@ any on-disk files,
regardless of whether or not
&scons;
knows about them from other Builder or function calls.
+</para>
-<example>
+<example_commands>
env.Tar('src.tar', 'src')
# Create the stuff.tar file.
@@ -54,42 +77,54 @@ env.Tar('foo.tar.gz', 'foo')
env = Environment(TARFLAGS = '-c -z',
TARSUFFIX = '.tgz')
env.Tar('foo')
-</example>
+</example_commands>
</summary>
</builder>
<cvar name="TAR">
<summary>
+<para>
The tar archiver.
+</para>
</summary>
</cvar>
<cvar name="TARCOM">
<summary>
+<para>
The command line used to call the tar archiver.
+</para>
</summary>
</cvar>
<cvar name="TARCOMSTR">
<summary>
+<para>
The string displayed when archiving files
using the tar archiver.
If this is not set, then &cv-link-TARCOM; (the command line) is displayed.
+</para>
-<example>
+<example_commands>
env = Environment(TARCOMSTR = "Archiving $TARGET")
-</example>
+</example_commands>
</summary>
</cvar>
<cvar name="TARFLAGS">
<summary>
+<para>
General options passed to the tar archiver.
+</para>
</summary>
</cvar>
<cvar name="TARSUFFIX">
<summary>
+<para>
The suffix used for tar file names.
+</para>
</summary>
</cvar>
+
+</sconsdoc> \ No newline at end of file