commit f1c57b39fd5e8abd4dfe276d793450b541f549d5
parent 518aa46158c56e75261ef095bdd313ade9197f46
Author: zeertzjq <zeertzjq@outlook.com>
Date: Tue, 3 Mar 2026 08:08:12 +0800
vim-patch:73f4162: runtime(doc): Tweak doc style in options.txt
https://github.com/vim/vim/commit/73f41626df1f1764007f073088048ffea4f970c4
Co-authored-by: Hirohito Higashi <h.east.727@gmail.com>
Diffstat:
3 files changed, 14 insertions(+), 11 deletions(-)
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
@@ -4102,7 +4102,7 @@ A jump table for the options with a short description can be found at |Q_op|.
The cursor is displayed at the start of the space a Tab character
occupies, not at the end as usual in Normal mode. To get this cursor
position while displaying Tabs with spaces, use: >vim
- set list lcs=tab:\ \
+ let &list = v:true | let &lcs = 'tab: '
<
Note that list mode will also affect formatting (set with 'textwidth'
or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
@@ -4175,9 +4175,9 @@ A jump table for the options with a short description can be found at |Q_op|.
Like |lcs-tab|, but only for leading tabs. When
omitted, the "tab" setting is used for leading tabs.
|lcs-tab| must also be set for this to work. *E1572*
- You can combine it with "tab:", for example:
- `:set listchars=tab:>-,leadtab:.\ `
- This shows leading tabs as periods(.) and other tabs
+ You can combine it with "tab:", for example: >vim
+ let &listchars = 'tab:>-,leadtab:. '
+< This shows leading tabs as periods(.) and other tabs
as ">--".
*lcs-trail*
trail:c Character to show for trailing spaces. When omitted,
diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
@@ -4097,7 +4097,7 @@ vim.go.lw = vim.go.lispwords
--- position while displaying Tabs with spaces, use:
---
--- ```vim
---- set list lcs=tab:\ \
+--- let &list = v:true | let &lcs = 'tab: '
--- ```
---
--- Note that list mode will also affect formatting (set with 'textwidth'
@@ -4186,8 +4186,11 @@ vim.wo.list = vim.o.list
--- omitted, the "tab" setting is used for leading tabs.
--- `lcs-tab` must also be set for this to work. *E1572*
--- You can combine it with "tab:", for example:
---- `:set listchars=tab:>-,leadtab:.\ `
---- This shows leading tabs as periods(.) and other tabs
+---
+--- ```vim
+--- let &listchars = 'tab:>-,leadtab:. '
+--- ```
+--- This shows leading tabs as periods(.) and other tabs
--- as ">--".
--- *lcs-trail*
--- trail:c Character to show for trailing spaces. When omitted,
diff --git a/src/nvim/options.lua b/src/nvim/options.lua
@@ -5387,7 +5387,7 @@ local options = {
The cursor is displayed at the start of the space a Tab character
occupies, not at the end as usual in Normal mode. To get this cursor
position while displaying Tabs with spaces, use: >vim
- set list lcs=tab:\ \
+ let &list = v:true | let &lcs = 'tab: '
<
Note that list mode will also affect formatting (set with 'textwidth'
or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
@@ -5469,9 +5469,9 @@ local options = {
Like |lcs-tab|, but only for leading tabs. When
omitted, the "tab" setting is used for leading tabs.
|lcs-tab| must also be set for this to work. *E1572*
- You can combine it with "tab:", for example:
- `:set listchars=tab:>-,leadtab:.\ `
- This shows leading tabs as periods(.) and other tabs
+ You can combine it with "tab:", for example: >vim
+ let &listchars = 'tab:>-,leadtab:. '
+ < This shows leading tabs as periods(.) and other tabs
as ">--".
*lcs-trail*
trail:c Character to show for trailing spaces. When omitted,