vim-patch:31ec664: runtime(doc): Update help syntax, match :autocmd options (#35008)

- Match :autocmd options and special buffer pattern.
- Normalise ellipsis (three dots) in Ex command argument lists.

closes: vim/vim#17793

31ec66403d

Co-authored-by: Doug Kearns <dougkearns@gmail.com>
This commit is contained in:
zeertzjq
2025-07-20 22:11:30 +08:00
committed by GitHub
parent 4962c60c6f
commit c556c6677b
4 changed files with 15 additions and 10 deletions

View File

@@ -630,7 +630,7 @@ list of the current window.
buffer. buffer.
Also see |++opt| and |+cmd|. Also see |++opt| and |+cmd|.
:[count]arge[dit][!] [++opt] [+cmd] {name} .. *:arge* *:argedit* :[count]arge[dit][!] [++opt] [+cmd] {name} ... *:arge* *:argedit*
Add {name}s to the argument list and edit it. Add {name}s to the argument list and edit it.
There is no check for duplicates, it is possible to There is no check for duplicates, it is possible to
add a file to the argument list twice |:argded|. add a file to the argument list twice |:argded|.
@@ -645,7 +645,7 @@ list of the current window.
edited. No check for duplicates is done. edited. No check for duplicates is done.
Also see |++opt| and |+cmd|. Also see |++opt| and |+cmd|.
:[count]arga[dd] {name} .. *:arga* *:argadd* *E479* :[count]arga[dd] {name} ... *:arga* *:argadd* *E479*
:[count]arga[dd] *E1156* :[count]arga[dd] *E1156*
Add the {name}s to the argument list. When {name} is Add the {name}s to the argument list. When {name} is
omitted add the current buffer name to the argument omitted add the current buffer name to the argument
@@ -676,7 +676,7 @@ list of the current window.
If your current file is a duplicate, your current file If your current file is a duplicate, your current file
will change to the original file index. will change to the original file index.
:argd[elete] {pattern} .. *:argd* *:argdelete* *E480* *E610* :argd[elete] {pattern} ... *:argd* *:argdelete* *E480* *E610*
Delete files from the argument list that match the Delete files from the argument list that match the
{pattern}s. {pattern} is used like a file pattern, {pattern}s. {pattern} is used like a file pattern,
see |file-pattern|. "%" can be used to delete the see |file-pattern|. "%" can be used to delete the

View File

@@ -3825,13 +3825,13 @@ SYNTAX ISKEYWORD SETTING *:syn-iskeyword*
DEFINING KEYWORDS *:syn-keyword* DEFINING KEYWORDS *:syn-keyword*
:sy[ntax] keyword {group-name} [{options}] {keyword} .. [{options}] :sy[ntax] keyword {group-name} [{options}] {keyword} ... [{options}]
This defines a number of keywords. This defines a number of keywords.
{group-name} Is a syntax group name such as "Comment". {group-name} Is a syntax group name such as "Comment".
[{options}] See |:syn-arguments| below. [{options}] See |:syn-arguments| below.
{keyword} .. Is a list of keywords which are part of this group. {keyword} ... Is a list of keywords which are part of this group.
Example: > Example: >
:syntax keyword Type int long char :syntax keyword Type int long char

View File

@@ -2460,7 +2460,7 @@ text...
line and not see the "|" that separates the commands. line and not see the "|" that separates the commands.
*:ec* *:echo* *:ec* *:echo*
:ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The :ec[ho] {expr1} ... Echoes each {expr1}, with a space in between. The
first {expr1} starts on a new line. first {expr1} starts on a new line.
Also see |:comment|. Also see |:comment|.
Use "\n" to start a new line. Use "\r" to move the Use "\n" to start a new line. Use "\r" to move the
@@ -2493,7 +2493,7 @@ text...
level. level.
*:echon* *:echon*
:echon {expr1} .. Echoes each {expr1}, without anything added. Also see :echon {expr1} ... Echoes each {expr1}, without anything added. Also see
|:comment|. |:comment|.
Uses the highlighting set by the `:echohl` command. Uses the highlighting set by the `:echohl` command.
Cannot be followed by a comment. Cannot be followed by a comment.
@@ -2524,7 +2524,7 @@ text...
otherwise all following echo's will be highlighted. otherwise all following echo's will be highlighted.
*:echom* *:echomsg* *:echom* *:echomsg*
:echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the :echom[sg] {expr1} ... Echo the expression(s) as a true message, saving the
message in the |message-history|. message in the |message-history|.
Spaces are placed between the arguments as with the Spaces are placed between the arguments as with the
`:echo` command. But unprintable characters are `:echo` command. But unprintable characters are
@@ -2539,8 +2539,9 @@ text...
:echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see." :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see."
< See |:echo-redraw| to avoid the message disappearing < See |:echo-redraw| to avoid the message disappearing
when the screen is redrawn. when the screen is redrawn.
*:echoe* *:echoerr* *:echoe* *:echoerr*
:echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the :echoe[rr] {expr1} ... Echo the expression(s) as an error message, saving the
message in the |message-history|. When used in a message in the |message-history|. When used in a
script or function the line number will be added. script or function the line number will be added.
Spaces are placed between the arguments as with the Spaces are placed between the arguments as with the
@@ -2572,7 +2573,7 @@ text...
*:exe* *:execute* *:exe* *:execute*
:exe[cute] {expr1} .. Executes the string that results from the evaluation :exe[cute] {expr1} ... Executes the string that results from the evaluation
of {expr1} as an Ex command. of {expr1} as an Ex command.
Multiple arguments are concatenated, with a space in Multiple arguments are concatenated, with a space in
between. To avoid the extra space use the ".." between. To avoid the extra space use the ".."

View File

@@ -108,6 +108,7 @@ syn match helpSpecial "^\t[>enf{}^L:=lbghNEpti+cC/(uUwWkmMjJ)*#P]N\s"ms=s+2,me=
syn match helpSpecial "{[-_a-zA-Z0-9'"*+/:%#=[\]<>.,]\+}" syn match helpSpecial "{[-_a-zA-Z0-9'"*+/:%#=[\]<>.,]\+}"
syn match helpSpecial "\s\[[-a-z^A-Z0-9_]\{2,}]"ms=s+1 syn match helpSpecial "\s\[[-a-z^A-Z0-9_]\{2,}]"ms=s+1
syn match helpSpecial "<[-a-zA-Z0-9_]\+>" syn match helpSpecial "<[-a-zA-Z0-9_]\+>"
syn match helpSpecial "<buffer=\w\+>"
syn match helpSpecial "<[SCM]-.>" syn match helpSpecial "<[SCM]-.>"
syn match helpNormal "<---*>" syn match helpNormal "<---*>"
syn match helpSpecial "\[range]" syn match helpSpecial "\[range]"
@@ -120,6 +121,9 @@ syn match helpSpecial "\[+num]"
syn match helpSpecial "\[-num]" syn match helpSpecial "\[-num]"
syn match helpSpecial "\[+cmd]" syn match helpSpecial "\[+cmd]"
syn match helpSpecial "\[++opt]" syn match helpSpecial "\[++opt]"
syn match helpSpecial "\[++once]"
syn match helpSpecial "\[++nested]"
syn match helpSpecial "\[++t]"
syn match helpSpecial "\[arg]" syn match helpSpecial "\[arg]"
syn match helpSpecial "\[arguments]" syn match helpSpecial "\[arguments]"
syn match helpSpecial "\[ident]" syn match helpSpecial "\[ident]"