adam/vim
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

runtime(doc): rewrite mkdir() doc and simplify {flags} meaning

Browse Source 
related: #14991

Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
Christian Brabandt
2024-06-13 21:21:41 +02:00
parent 8b34aea1b0
commit d6d4e13336
1 changed files with 7 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
runtime/doc/builtin.txt
View File

@ -7329,17 +7329,14 @@ mkdir({name} [, {flags} [, {prot}]]) *mkdir()* *E739*
When {flags} is present it must be a string. An empty string When {flags} is present it must be a string. An empty string
has no effect. has no effect.
If {flags} contains "p" then intermediate directories are {flags} can contain these character flags:
created as necessary. "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|
If {flags} contains "D" then {name} is deleted at the end of Note that when {name} has more than one part and "p" is used
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
some directories may already exist. Only the first one that some directories may already exist. Only the first one that
is created and what it contains is scheduled to be deleted. is created and what it contains is scheduled to be deleted.
E.g. when using: > E.g. when using: >