jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Adds hyperlinks to copyFile* docstrings.

Browse source
This commit is contained in:
Grzegorz Adam Hankiewicz 2014-07-27 20:27:38 +02:00
commit d597767d70
1 changed files with 15 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

26
lib/pure/os.nim
View file

@ -955,11 +955,12 @@ proc copyFile*(source, dest: string) {.rtl, extern: "nos$1",
## ##
## If this fails, `EOS` is raised. On the Windows platform this proc will ## If this fails, `EOS` is raised. On the Windows platform this proc will
## copy the source file's attributes into dest. On other platforms you need ## copy the source file's attributes into dest. On other platforms you need
## to use getFilePermissions and setFilePermissions to copy them by hand (or ## to use `getFilePermissions() <#getFilePermissions>`_ and
## use the convenience copyFileWithPermissions() proc), otherwise `dest` will ## `setFilePermissions() <#setFilePermissions>`_ to copy them by hand (or use
## inherit the default permissions of a newly created file for the user. If ## the convenience `copyFileWithPermissions() <#copyFileWithPermissions>`_
## `dest` already exists, the file attributes will be preserved and the ## proc), otherwise `dest` will inherit the default permissions of a newly
## content overwritten. ## created file for the user. If `dest` already exists, the file attributes
## will be preserved and the content overwritten.
when defined(Windows): when defined(Windows):
when useWinUnicode: when useWinUnicode:
let s = newWideCString(source) let s = newWideCString(source)
@ -1513,14 +1514,17 @@ proc copyFileWithPermissions*(source, dest: string,
ignorePermissionErrors = true) = ignorePermissionErrors = true) =
## Copies a file from `source` to `dest` preserving file permissions. ## Copies a file from `source` to `dest` preserving file permissions.
## ##
## This is a wrapper proc around copyFile, getFilePermissions and ## This is a wrapper proc around `copyFile() <#copyFile>`_,
## setFilePermissions on non Windows platform. On windows this proc is just a ## `getFilePermissions() <#getFilePermissions>`_ and `setFilePermissions()
## wrapper for copyFile since that proc already copies attributes. ## <#setFilePermissions>`_ on non Windows platform. On Windows this proc is
## just a wrapper for `copyFile() <#copyFile>`_ since that proc already
## copies attributes.
## ##
## On non windows systems permissions are copied after the file itself has ## On non Windows systems permissions are copied after the file itself has
## been copied, which won't happen atomically and could lead to a race ## been copied, which won't happen atomically and could lead to a race
## condition. If ignorePermissionErrors is true, errors while reading/setting ## condition. If `ignorePermissionErrors` is true, errors while
## file attributes will be ignored, otherwise will raise `OSError`. ## reading/setting file attributes will be ignored, otherwise will raise
## `OSError`.
copyFile(source, dest) copyFile(source, dest)
when not defined(Windows): when not defined(Windows):
try: try: