summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorWilliam Blevins <wblevins@gmail.com>2014-08-09 13:37:09 -0400
committerWilliam Blevins <wblevins@gmail.com>2014-08-09 13:37:09 -0400
commit90c0d46ffd47f8a17669041f845103618f05a21c (patch)
tree1e9573c1b1ada1b875c3ecd7da8cbbeb66740258 /doc
parentd6151edc7c0e6669173726a1f8f00bb31a086ff8 (diff)
downloadscons-90c0d46ffd47f8a17669041f845103618f05a21c.tar.gz
Updated Issue 2395 documentation per request.
Diffstat (limited to 'doc')
-rw-r--r--doc/user/factories.xml23
1 files changed, 10 insertions, 13 deletions
diff --git a/doc/user/factories.xml b/doc/user/factories.xml
index 815efe3b..c8480dba 100644
--- a/doc/user/factories.xml
+++ b/doc/user/factories.xml
@@ -177,25 +177,22 @@ touch $*
</scons_output>
<para>
- The &Copy; factory supports symbolic link copying behavior
- which is controlled by a third optional argument.
+ The &Copy; factory has a third optional argument which controls
+ how symlinks are copied.
</para>
<para>
- Symbolic links shallow copied as new symbolic links:
</para>
- <para>
- <literal>Command("LinkIn", "LinkOut1", Copy("$TARGET", "$SOURCE"[, True]))</literal>
- </para>
+ <scons_example name="factories_SymlinkCopy">
+ <file name ="SymlinkCopy" printme="1">
+# Symbolic link shallow copied as a new symbolic link:
+Command("LinkIn", "LinkOut", Copy("$TARGET", "$SOURCE"[, True]))
- <para>
- Symbolic link deep copied as file target file or directory:
- </para>
-
- <para>
- <literal>Command("LinkIn", "FileOut", Copy("$TARGET", "$SOURCE", False))</literal>
- </para>
+# Symbolic link target copied as a file or directory:
+Command("LinkIn", "FileOrDirectoryOut", Copy("$TARGET", "$SOURCE", False))
+ </file>
+ </scons_example>
</section>