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

Merge pull request #392 from gradha/pr_improves_os_docstrings

Browse source 
Adds to docstrings link between removeFile and removeDir.
This commit is contained in:
Simon Hafner 2013-04-17 22:25:50 -07:00
commit fcb4344ac5
1 changed files with 11 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

15
lib/pure/os.nim
View file

@ -794,8 +794,11 @@ when not defined(ENOENT):
var ENOENT {.importc, header: "<errno.h>".}: cint var ENOENT {.importc, header: "<errno.h>".}: cint
proc removeFile*(file: string) {.rtl, extern: "nos$1", tags: [FWriteDir].} = proc removeFile*(file: string) {.rtl, extern: "nos$1", tags: [FWriteDir].} =
## Removes the `file`. If this fails, `EOS` is raised. This does not fail ## Removes the `file`.
## if the file never existed in the first place. ##
## If this fails, `EOS` is raised. This does not fail if the file never
## existed in the first place. Despite the name of this proc you can also
## call it on directories, but they will only be removed if they are empty.
if cremove(file) != 0'i32 and errno != ENOENT: OSError() if cremove(file) != 0'i32 and errno != ENOENT: OSError()
proc execShellCmd*(command: string): int {.rtl, extern: "nos$1", proc execShellCmd*(command: string): int {.rtl, extern: "nos$1",
@ -1076,8 +1079,12 @@ proc rawRemoveDir(dir: string) =
proc removeDir*(dir: string) {.rtl, extern: "nos$1", tags: [ proc removeDir*(dir: string) {.rtl, extern: "nos$1", tags: [
FWriteDir, FReadDir].} = FWriteDir, FReadDir].} =
## Removes the directory `dir` including all subdirectories and files ## Removes the directory `dir` including all subdirectories and files
## in `dir` (recursively). If this fails, `EOS` is raised. This does not fail ## in `dir` (recursively).
## if the directory never existed in the first place. ##
## If this fails, `EOS` is raised. This does not fail if the directory never
## existed in the first place. If you need non recursive directory removal
## which fails when the directory contains files use the `removeFile` proc
## instead.
for kind, path in walkDir(dir): for kind, path in walkDir(dir):
case kind case kind
of pcFile, pcLinkToFile, pcLinkToDir: removeFile(path) of pcFile, pcLinkToFile, pcLinkToDir: removeFile(path)