summaryrefslogtreecommitdiffstats
path: root/src/engine/SCons/Tool/packaging/__init__.xml
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2010-07-21 16:42:26 (GMT)
committerSteven Knight <knight@baldmt.com>2010-07-21 16:42:26 (GMT)
commitf47c9af3748b0eb9c6f0b1d0f8aeec1dd9a0bfa1 (patch)
tree571c2f903cc940142c5abfc7a56ed48f4b547bdc /src/engine/SCons/Tool/packaging/__init__.xml
parent324f4aa55703916b94e7660f7f65d29f4bc9c1e5 (diff)
downloadSCons-f47c9af3748b0eb9c6f0b1d0f8aeec1dd9a0bfa1.zip
SCons-f47c9af3748b0eb9c6f0b1d0f8aeec1dd9a0bfa1.tar.gz
SCons-f47c9af3748b0eb9c6f0b1d0f8aeec1dd9a0bfa1.tar.bz2
Move the authoritative source for functions from the man page to various
.xml files (some new, some updated) next to the modules that implement them. Generate the man page using the output generated from the .xml file by bin/scons-proc.py.
Diffstat (limited to 'src/engine/SCons/Tool/packaging/__init__.xml')
-rw-r--r--src/engine/SCons/Tool/packaging/__init__.xml23
1 files changed, 15 insertions, 8 deletions
diff --git a/src/engine/SCons/Tool/packaging/__init__.xml b/src/engine/SCons/Tool/packaging/__init__.xml
index beae914..6fec7bd 100644
--- a/src/engine/SCons/Tool/packaging/__init__.xml
+++ b/src/engine/SCons/Tool/packaging/__init__.xml
@@ -502,7 +502,6 @@ field in the RPM
</cvar>
-
<!--
THE FOLLOWING AREN'T CONSTRUCTION VARIABLES,
@@ -627,24 +626,32 @@ TODO
-->
-<!--
-<builder name="Tag">
+<scons_function name="Tag">
+<arguments signature="global">
+(node, tags)
+</arguments>
<summary>
-Leaves hints for the Package() Builder on how specific
-files or directories should be packaged.
+Annotates file or directory Nodes with
+information about how the
+&f-link-Package;
+Builder should package those files or directories.
All tags are optional.
+Examples:
+
<example>
# makes sure the built library will be installed with 0644 file
# access mode
-Tag( Library( 'lib.c' ), unix-attr="0644" )
+Tag( Library( 'lib.c' ), UNIX_ATTR="0644" )
# marks file2.txt to be a documentation file
-Tag( 'file2.txt', doc )
+Tag( 'file2.txt', DOC )
</example>
</summary>
-</builder>
+</scons_function>
+
+<!--
<function name="FindSourceFiles">
<summary>
A convenience function which returns all leaves of the build tree.