From 84a2d823537b9257b7e4b4a5daacb8fc0b962d16 Mon Sep 17 00:00:00 2001 From: William Blevins Date: Sat, 19 Jul 2014 21:19:44 -0400 Subject: Issue 2395: Added doc comment for symlink parameter usage. --- src/engine/SCons/Defaults.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/engine/SCons/Defaults.py b/src/engine/SCons/Defaults.py index b91a685..3f60bc0 100644 --- a/src/engine/SCons/Defaults.py +++ b/src/engine/SCons/Defaults.py @@ -182,6 +182,13 @@ def chmod_strfunc(dest, mode): Chmod = ActionFactory(chmod_func, chmod_strfunc) def copy_func(dest, src, symlinks=True): + """ + If symlinks (is true), then a symbolic link will be + shallow copied and recreated as a symbolic link; otherwise, copying + a symbolic link will be equivalent to copying the symbolic link's + final target regardless of symbolic link depth. + """ + dest = str(dest) src = str(src) -- cgit v0.12