[vim/vim] Improve syntax/vim.vim generator (PR #16331)

h_east

unread,

Dec 28, 2024, 4:48:14 PM12/28/24

to vim/vim, Subscribed

Improvements

Add check_doc command for generator make.
When execute make check_doc, it checks the consistency between the ex-cmd and the help documentation.
(Currently there are a lot of error reports, but I plan to fix them after this PR is merged. 👍 )
NOTE: It takes about 5 minutes to run make check_doc on my PC.

Bugfixes

Fix the incorrect shortened pattern for the following commands.
:scriptname, :simalt, :srewind

You can view, comment on, or merge this pull request online at:

https://github.com/vim/vim/pull/16331

Commit Summary

dd2361a Improve syntax/vim.vim generator

File Changes

(4 files)

M runtime/syntax/generator/Makefile (43)
M runtime/syntax/generator/gen_syntax_vim.vim (207)
M runtime/syntax/generator/update_date.vim (1)
M runtime/syntax/vim.vim (4)

Patch Links:

—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.

Christian Brabandt

unread,

Dec 29, 2024, 3:45:28 AM12/29/24

to vim/vim, Subscribed

ping @dkearns ?

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

dkearns

unread,

Dec 29, 2024, 8:26:17 AM12/29/24

to vim/vim, Subscribed

Looks like a nice addition, thanks @h-east.

You may be aware of this but there's some false positives in the results for the Vim9 commands that cannot be shorted. E.g., the following is wrong on both counts,

Ex-cmd "final" short name differ in index.txt. expect: "fina[l]", but: "final"
Ex-cmd "finally" short name differ in index.txt. expect: "finall[y]", but: "fina[lly]"

and we're also incorrectly generating finall[y] for the syntax definition.

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

Christian Brabandt

unread,

Dec 29, 2024, 9:15:55 AM12/29/24

to vim/vim, Subscribed

Thanks all, I include it then.

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

Christian Brabandt

unread,

Dec 29, 2024, 9:17:08 AM12/29/24

to vim/vim, Subscribed

Closed #16331 via f0ab3e4.

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

h_east

unread,

Dec 29, 2024, 9:52:55 AM12/29/24

to vim/vim, Subscribed

@chrisbra Thanks for merging.

@dkearns Thanks for reviewing.
Yes, as you pointed out, the results include false positives (mainly related to shortened command names).
Since this PR has been merged, I will proceed with the corrections to the documentation and scripts.