aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--runtime/doc/builtin.txt9
-rw-r--r--runtime/lua/vim/_meta/vimfn.lua9
-rw-r--r--src/nvim/eval.lua9
3 files changed, 15 insertions, 12 deletions
diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt
index 031d2d6fcd..bbbabea2a4 100644
--- a/runtime/doc/builtin.txt
+++ b/runtime/doc/builtin.txt
@@ -6962,10 +6962,11 @@ shellescape({string} [, {special}]) *shellescape()*
Otherwise encloses {string} in single-quotes and replaces all
"'" with "'\''".
- If {special} is a |non-zero-arg|:
- - Special items such as "!", "%", "#" and "<cword>" will be
- preceded by a backslash. The backslash will be removed again
- by the |:!| command.
+ The {special} argument adds additional escaping of keywords
+ used in Vim commands. If it is a |non-zero-arg|:
+ - Special items such as "!", "%", "#" and "<cword>" (as listed
+ in |expand()|) will be preceded by a backslash.
+ The backslash will be removed again by the |:!| command.
- The <NL> character is escaped.
If 'shell' contains "csh" in the tail:
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index dc25b0dd40..853f354275 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -8293,10 +8293,11 @@ function vim.fn.sha256(string) end
--- Otherwise encloses {string} in single-quotes and replaces all
--- "'" with "'\''".
---
---- If {special} is a |non-zero-arg|:
---- - Special items such as "!", "%", "#" and "<cword>" will be
---- preceded by a backslash. The backslash will be removed again
---- by the |:!| command.
+--- The {special} argument adds additional escaping of keywords
+--- used in Vim commands. If it is a |non-zero-arg|:
+--- - Special items such as "!", "%", "#" and "<cword>" (as listed
+--- in |expand()|) will be preceded by a backslash.
+--- The backslash will be removed again by the |:!| command.
--- - The <NL> character is escaped.
---
--- If 'shell' contains "csh" in the tail:
diff --git a/src/nvim/eval.lua b/src/nvim/eval.lua
index 628c546c4a..f0eeca2f10 100644
--- a/src/nvim/eval.lua
+++ b/src/nvim/eval.lua
@@ -9903,10 +9903,11 @@ M.funcs = {
Otherwise encloses {string} in single-quotes and replaces all
"'" with "'\''".
- If {special} is a |non-zero-arg|:
- - Special items such as "!", "%", "#" and "<cword>" will be
- preceded by a backslash. The backslash will be removed again
- by the |:!| command.
+ The {special} argument adds additional escaping of keywords
+ used in Vim commands. If it is a |non-zero-arg|:
+ - Special items such as "!", "%", "#" and "<cword>" (as listed
+ in |expand()|) will be preceded by a backslash.
+ The backslash will be removed again by the |:!| command.
- The <NL> character is escaped.
If 'shell' contains "csh" in the tail: