vim-patch:5faeb60480c6 (#28768)

runtime(doc): clarify {special} argument for shellescape()

closes: vim/vim#14770

5faeb60480

N/A patch:
vim-patch:c0e038b59f84

Co-authored-by: Enno <Konfekt@users.noreply.github.com>
This commit is contained in:
zeertzjq 2024-05-16 14:29:56 +08:00 committed by GitHub
parent 9ca81b0259
commit 618e34ca09
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 15 additions and 12 deletions

View File

@ -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:

View File

@ -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:

View File

@ -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: