diff options
| author | Christian Brabandt <cb@256bit.org> | 2024-06-13 21:21:41 +0200 |
|---|---|---|
| committer | Christian Brabandt <cb@256bit.org> | 2024-06-13 21:24:51 +0200 |
| commit | d6d4e1333659c0d2acee3133819498d014df47de (patch) | |
| tree | c3f80c891e8a6d46e32dfe24681148737cbc39c2 /runtime | |
| parent | 8b34aea1b0431082a062ecfb5de0f244f3f23418 (diff) | |
runtime(doc): rewrite mkdir() doc and simplify {flags} meaning
related: #14991
Signed-off-by: Christian Brabandt <cb@256bit.org>
Diffstat (limited to 'runtime')
| -rw-r--r-- | runtime/doc/builtin.txt | 19 |
1 files changed, 8 insertions, 11 deletions
diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt index dd46430e93..862a1dfc62 100644 --- a/runtime/doc/builtin.txt +++ b/runtime/doc/builtin.txt @@ -7329,17 +7329,14 @@ mkdir({name} [, {flags} [, {prot}]]) *mkdir()* *E739* When {flags} is present it must be a string. An empty string has no effect. - If {flags} contains "p" then intermediate directories are - created as necessary. - - If {flags} contains "D" then {name} is deleted at the end of - the current function, as with: > - defer delete({name}, 'd') -< - If {flags} contains "R" then {name} is deleted recursively at - the end of the current function, as with: > - defer delete({name}, 'rf') -< Note that when {name} has more than one part and "p" is used + {flags} can contain these character flags: + "p" intermediate directories will be created as necessary + "D" {name} will be deleted at the end of the current + function, but not recursively |defer| + "R" {name} will be deleted recursively at the end of the + current function |defer| + + Note that when {name} has more than one part and "p" is used some directories may already exist. Only the first one that is created and what it contains is scheduled to be deleted. E.g. when using: > |