]> git.ipfire.org Git - thirdparty/vim.git/commitdiff
runtime(doc): rewrite mkdir() doc and simplify {flags} meaning
authorChristian Brabandt <cb@256bit.org>
Thu, 13 Jun 2024 19:21:41 +0000 (21:21 +0200)
committerChristian Brabandt <cb@256bit.org>
Thu, 13 Jun 2024 19:24:51 +0000 (21:24 +0200)
related: #14991

Signed-off-by: Christian Brabandt <cb@256bit.org>
runtime/doc/builtin.txt

index dd46430e93bb3bafee525479a054e568bd3e64e1..862a1dfc624b5d8b92c789118d66102b7fd7c405 100644 (file)
@@ -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: >