summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorWilliam Blevins <wblevins@gmail.com>2014-07-20 19:16:12 (GMT)
committerWilliam Blevins <wblevins@gmail.com>2014-07-20 19:16:12 (GMT)
commitf7384a54a0d60838d10130f70790b4a16584c746 (patch)
tree032581763a681097d65f3722be7ebc0aa73b2c8f /doc
parent78dde7017bdd278f24ea885514fbbf0e6c600711 (diff)
downloadSCons-f7384a54a0d60838d10130f70790b4a16584c746.zip
SCons-f7384a54a0d60838d10130f70790b4a16584c746.tar.gz
SCons-f7384a54a0d60838d10130f70790b4a16584c746.tar.bz2
Issue 2395: Added user guide details for Copy symbolic link support.
Diffstat (limited to 'doc')
-rw-r--r--doc/user/factories.xml21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/user/factories.xml b/doc/user/factories.xml
index 08f20e6..815efe3 100644
--- a/doc/user/factories.xml
+++ b/doc/user/factories.xml
@@ -176,6 +176,27 @@ touch $*
<scons_output_command>scons -Q</scons_output_command>
</scons_output>
+ <para>
+ The &Copy; factory supports symbolic link copying behavior
+ which is controlled by a third optional argument.
+ </para>
+
+ <para>
+ Symbolic links shallow copied as new symbolic links:
+ </para>
+
+ <para>
+ <literal>Command("LinkIn", "LinkOut1", Copy("$TARGET", "$SOURCE"[, True]))</literal>
+ </para>
+
+ <para>
+ Symbolic link deep copied as file target file or directory:
+ </para>
+
+ <para>
+ <literal>Command("LinkIn", "FileOut", Copy("$TARGET", "$SOURCE", False))</literal>
+ </para>
+
</section>
<section>