diff options
| author | William Blevins <wblevins@gmail.com> | 2014-07-20 01:19:44 (GMT) |
|---|---|---|
| committer | William Blevins <wblevins@gmail.com> | 2014-07-20 01:19:44 (GMT) |
| commit | 84a2d823537b9257b7e4b4a5daacb8fc0b962d16 (patch) | |
| tree | a408bdde4f2cc6da1b650ed4be81b49bbe667a35 /src/engine | |
| parent | 5298a7b408e87b9fbfb0a4c5193b36698913a47c (diff) | |
| download | SCons-84a2d823537b9257b7e4b4a5daacb8fc0b962d16.zip SCons-84a2d823537b9257b7e4b4a5daacb8fc0b962d16.tar.gz SCons-84a2d823537b9257b7e4b4a5daacb8fc0b962d16.tar.bz2 | |
Issue 2395: Added doc comment for symlink parameter usage.
Diffstat (limited to 'src/engine')
| -rw-r--r-- | src/engine/SCons/Defaults.py | 7 |
1 files changed, 7 insertions, 0 deletions
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) |