adam/vim
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

runtime(doc): tweak documentation style

Browse Source 
closes: #18284

Signed-off-by: Hirohito Higashi <h.east.727@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
Hirohito Higashi
2025-09-13 10:52:36 -04:00
committed by Christian Brabandt
parent e8bbdb90e4
commit 450d59145e
3 changed files with 121 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
runtime/doc/ft_hare.txt
View File

@ -131,4 +131,4 @@ configuration that exists. For example: >
The global default is "-q", to suppress writing to stdout while building. The global default is "-q", to suppress writing to stdout while building.
============================================================================== ==============================================================================
vim:ft=help:noet:ts=8:tw=78:norl: vim:tw=78:ts=8:noet:ft=help:norl:

95
runtime/doc/options.txt
View File

@ -1,4 +1,4 @@
*options.txt* For Vim version 9.1. Last change: 2025 Sep 11 *options.txt* For Vim version 9.1. Last change: 2025 Sep 13
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -1108,8 +1108,8 @@ A jump table for the options with a short description can be found at |Q_op|.
eol allow backspacing over line breaks (join lines) eol allow backspacing over line breaks (join lines)
start allow backspacing over the start of insert; CTRL-W and CTRL-U start allow backspacing over the start of insert; CTRL-W and CTRL-U
stop once at the start of insert. stop once at the start of insert.
nostop like start, except CTRL-W and CTRL-U do not stop at the start of nostop like start, except CTRL-W and CTRL-U do not stop at the start
insert. of insert.
When the value is empty, Vi compatible backspacing is used, none of When the value is empty, Vi compatible backspacing is used, none of
the ways mentioned for the items above are possible. the ways mentioned for the items above are possible.
@ -2153,20 +2153,20 @@ A jump table for the options with a short description can be found at |Q_op|.
name of a function or a |Funcref|. For |Funcref| values, name of a function or a |Funcref|. For |Funcref| values,
spaces must be escaped with a backslash ('\'), and commas with spaces must be escaped with a backslash ('\'), and commas with
double backslashes ('\\') (see |option-backslash|). double backslashes ('\\') (see |option-backslash|).
Unlike other sources, functions can provide completions starting Unlike other sources, functions can provide completions
from a non-keyword character before the cursor, and their starting from a non-keyword character before the cursor, and
start position for replacing text may differ from other sources. their start position for replacing text may differ from other
If the Dict returned by the {func} includes {"refresh": "always"}, sources. If the Dict returned by the {func} includes
the function will be invoked again whenever the leading text {"refresh": "always"}, the function will be invoked again
changes. whenever the leading text changes.
If generating matches is potentially slow, call If generating matches is potentially slow, call
|complete_check()| periodically to keep Vim responsive. This |complete_check()| periodically to keep Vim responsive. This
is especially important for |ins-autocompletion|. is especially important for |ins-autocompletion|.
F equivalent to using "F{func}", where the function is taken from F equivalent to using "F{func}", where the function is taken
the 'completefunc' option. from the 'completefunc' option.
o equivalent to "F{func}", where {func} is taken from the 'omnifunc' o equivalent to "F{func}", where {func} is taken from the
option. If a plugin (such as an LSP client) defines 'omnifunc', it 'omnifunc' option. If a plugin (such as an LSP client)
can be used through this flag. defines 'omnifunc', it can be used through this flag.
Unloaded buffers are not loaded, thus their autocmds |:autocmd| are Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
not executed, this may lead to unexpected completions from some files not executed, this may lead to unexpected completions from some files
@ -2189,8 +2189,8 @@ A jump table for the options with a short description can be found at |Q_op|.
An optional match limit can be specified for a completion source by An optional match limit can be specified for a completion source by
appending a caret ("^") followed by a {count} to the source flag. appending a caret ("^") followed by a {count} to the source flag.
For example: ".^9,w,u,t^5" limits matches from the current buffer For example: ".^9,w,u,t^5" limits matches from the current buffer to 9
to 9 and from tags to 5. Other sources remain unlimited. and from tags to 5. Other sources remain unlimited.
Note: The match limit takes effect only during forward completion Note: The match limit takes effect only during forward completion
(CTRL-N) and is ignored during backward completion (CTRL-P). (CTRL-N) and is ignored during backward completion (CTRL-P).
@ -2862,8 +2862,8 @@ A jump table for the options with a short description can be found at |Q_op|.
global global
{not available when compiled without the |+cscope| {not available when compiled without the |+cscope|
feature} feature}
In the absence of a prefix (-P) for cscope. setting this option enables In the absence of a prefix (-P) for cscope. setting this option
to use the basename of cscope.out path as the prefix. enables to use the basename of cscope.out path as the prefix.
See |cscoperelative|. See |cscoperelative|.
NOTE: This option is reset when 'compatible' is set. NOTE: This option is reset when 'compatible' is set.
@ -3067,8 +3067,8 @@ A jump table for the options with a short description can be found at |Q_op|.
security reasons. security reasons.
*'dip'* *'diffopt'* *'dip'* *'diffopt'*
'diffopt' 'dip' string (default 'diffopt' 'dip' string (default "internal,filler,closeoff,
"internal,filler,closeoff,indent-heuristic,inline:char") indent-heuristic,inline:char")
global global
{not available when compiled without the |+diff| {not available when compiled without the |+diff|
feature} feature}
@ -3188,8 +3188,8 @@ A jump table for the options with a short description can be found at |Q_op|.
very large diff hunks there will be a very large diff hunks there will be a
noticeable lag. A reasonable setting is noticeable lag. A reasonable setting is
"linematch:60", as this will enable alignment "linematch:60", as this will enable alignment
for a 2 buffer diff hunk of 30 lines each, for a 2 buffer diff hunk of 30 lines each, or
or a 3 buffer diff hunk of 20 lines each. a 3 buffer diff hunk of 20 lines each.
Implicitly sets "filler" when this is set. Implicitly sets "filler" when this is set.
vertical Start diff mode with vertical splits (unless vertical Start diff mode with vertical splits (unless
@ -3439,8 +3439,8 @@ A jump table for the options with a short description can be found at |Q_op|.
makes a difference for error messages, the bell will be used always makes a difference for error messages, the bell will be used always
for a lot of errors without a message (e.g., hitting <Esc> in Normal for a lot of errors without a message (e.g., hitting <Esc> in Normal
mode). See 'visualbell' on how to make the bell behave like a beep, mode). See 'visualbell' on how to make the bell behave like a beep,
screen flash or do nothing. See 'belloff' to finetune when to ring the screen flash or do nothing. See 'belloff' to finetune when to ring
bell. the bell.
*'errorfile'* *'ef'* *'errorfile'* *'ef'*
'errorfile' 'ef' string (Amiga default: "AztecC.Err", 'errorfile' 'ef' string (Amiga default: "AztecC.Err",
@ -4474,8 +4474,8 @@ A jump table for the options with a short description can be found at |Q_op|.
'e' Add tab pages when indicated with 'showtabline'. 'e' Add tab pages when indicated with 'showtabline'.
'guitablabel' can be used to change the text in the labels. 'guitablabel' can be used to change the text in the labels.
When 'e' is missing a non-GUI tab pages line may be used. When 'e' is missing a non-GUI tab pages line may be used.
The GUI tabs are only supported on some systems, currently The GUI tabs are only supported on some systems, currently GTK,
GTK, Motif, Mac OS/X, Haiku, and MS-Windows. Motif, Mac OS/X, Haiku, and MS-Windows.
*'go-f'* *'go-f'*
'f' Foreground: Don't use fork() to detach the GUI from the shell 'f' Foreground: Don't use fork() to detach the GUI from the shell
where it was started. Use this for programs that wait for the where it was started. Use this for programs that wait for the
@ -6415,9 +6415,9 @@ A jump table for the options with a short description can be found at |Q_op|.
The value is the minimum width. A bigger width is used when needed to The value is the minimum width. A bigger width is used when needed to
fit the highest line number in the buffer respectively the number of fit the highest line number in the buffer respectively the number of
rows in the window, depending on whether 'number' or 'relativenumber' rows in the window, depending on whether 'number' or 'relativenumber'
is set. Thus with the Vim default of 4 there is room for a line number is set. Thus with the Vim default of 4 there is room for a line
up to 999. When the buffer has 1000 lines five columns will be used. number up to 999. When the buffer has 1000 lines five columns will be
The minimum value is 1, the maximum value is 20. used. The minimum value is 1, the maximum value is 20.
NOTE: This option is set to the Vi default value when 'compatible' is NOTE: This option is set to the Vi default value when 'compatible' is
set and to the Vim default value when 'compatible' is reset. set and to the Vim default value when 'compatible' is reset.
@ -6803,10 +6803,10 @@ A jump table for the options with a short description can be found at |Q_op|.
global global
{only available when compiled with the |+python/dyn| {only available when compiled with the |+python/dyn|
feature} feature}
Specifies the name of the Python 2.x home directory. When 'pythonhome' Specifies the name of the Python 2.x home directory. When
and the PYTHONHOME environment variable are not set, PYTHON_HOME, 'pythonhome' and the PYTHONHOME environment variable are not set,
which was specified at compile time, will be used for the Python 2.x PYTHON_HOME, which was specified at compile time, will be used for the
home directory. Python 2.x home directory.
Environment variables are expanded |:set_env|. Environment variables are expanded |:set_env|.
This option cannot be set from a |modeline| or in the |sandbox|, for This option cannot be set from a |modeline| or in the |sandbox|, for
security reasons. security reasons.
@ -6937,10 +6937,10 @@ A jump table for the options with a short description can be found at |Q_op|.
Show the line number relative to the line with the cursor in front of Show the line number relative to the line with the cursor in front of
each line. Relative line numbers help you use the |count| you can each line. Relative line numbers help you use the |count| you can
precede some vertical motion commands (e.g. j k + -) with, without precede some vertical motion commands (e.g. j k + -) with, without
having to calculate it yourself. Especially useful in combination with having to calculate it yourself. Especially useful in combination
other commands (e.g. y d c < > gq gw =). with other commands (e.g. y d c < > gq gw =).
When the 'n' option is excluded from 'cpoptions' a wrapped When the 'n' option is excluded from 'cpoptions' a wrapped line will
line will not use the column of line numbers (this is the default when not use the column of line numbers (this is the default when
'compatible' isn't set). 'compatible' isn't set).
The 'numberwidth' option can be used to set the room used for the line The 'numberwidth' option can be used to set the room used for the line
number. number.
@ -8246,8 +8246,8 @@ A jump table for the options with a short description can be found at |Q_op|.
For the "screen" and "topline" values, the cursor position will be For the "screen" and "topline" values, the cursor position will be
changed when necessary. In this case, the jumplist will be populated changed when necessary. In this case, the jumplist will be populated
with the previous cursor position. For "screen", the text cannot always with the previous cursor position. For "screen", the text cannot
be kept on the same screen line when 'wrap' is enabled. always be kept on the same screen line when 'wrap' is enabled.
*'splitright'* *'spr'* *'nosplitright'* *'nospr'* *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
'splitright' 'spr' boolean (default off) 'splitright' 'spr' boolean (default off)
@ -9507,8 +9507,8 @@ A jump table for the options with a short description can be found at |Q_op|.
{only available when compiled with the |+vartabs| {only available when compiled with the |+vartabs|
feature} feature}
Defines variable-width tab stops. The value is a comma-separated list Defines variable-width tab stops. The value is a comma-separated list
of widths in columns. Each width defines the number of columns of widths in columns. Each width defines the number of columns before
before the next tab stop; the last value repeats indefinitely. the next tab stop; the last value repeats indefinitely.
For example: > For example: >
:set vartabstop=4,8 :set vartabstop=4,8
@ -9772,9 +9772,8 @@ A jump table for the options with a short description can be found at |Q_op|.
to get a shorter or longer flash. to get a shorter or longer flash.
Note: Vim will limit the bell to once per half a second. This avoids Note: Vim will limit the bell to once per half a second. This avoids
having to wait for the flashing to finish when there are lots of having to wait for the flashing to finish when there are lots of bells,
bells, e.g. on key repeat. This also happens without 'visualbell' e.g. on key repeat. This also happens without 'visualbell' set.
set.
In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
for 20 msec. If you want to use a different time, use "<Esc>|40f", for 20 msec. If you want to use a different time, use "<Esc>|40f",
@ -10043,8 +10042,8 @@ A jump table for the options with a short description can be found at |Q_op|.
expansion. Currently fuzzy matching based completion expansion. Currently fuzzy matching based completion
is not supported for file and directory names and is not supported for file and directory names and
instead wildcard expansion is used. instead wildcard expansion is used.
pum Display the completion matches using the popup menu pum Display the completion matches using the popup menu in
in the same style as the |ins-completion-menu|. the same style as the |ins-completion-menu|.
tagfile When using CTRL-D to list matching tags, the kind of tagfile When using CTRL-D to list matching tags, the kind of
tag and the file of the tag is listed. Only one match tag and the file of the tag is listed. Only one match
is displayed per line. Often used tag kinds are: is displayed per line. Often used tag kinds are:
@ -10171,8 +10170,8 @@ A jump table for the options with a short description can be found at |Q_op|.
{only available when compiled with the |terminal| {only available when compiled with the |terminal|
feature on MS-Windows} feature on MS-Windows}
Specifies the name of the winpty shared library, used for the Specifies the name of the winpty shared library, used for the
|:terminal| command. The default depends on whether Vim was built as a |:terminal| command. The default depends on whether Vim was built as
32-bit or 64-bit executable. If not found, "winpty.dll" is tried as a 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
a fallback. a fallback.
Environment variables are expanded |:set_env|. Environment variables are expanded |:set_env|.
This option cannot be set from a |modeline| or in the |sandbox|, for This option cannot be set from a |modeline| or in the |sandbox|, for

4
runtime/doc/version9.txt
View File

@ -1,4 +1,4 @@
*version9.txt* For Vim version 9.1. Last change: 2025 Sep 11 *version9.txt* For Vim version 9.1. Last change: 2025 Sep 13
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -41670,7 +41670,7 @@ Default values: ~
- the default value for 'showcmd' is always enabled when using non-compatible - the default value for 'showcmd' is always enabled when using non-compatible
mode (previously, it was off on UNIX systems) and consequently removed from mode (previously, it was off on UNIX systems) and consequently removed from
|defaults.vim| |defaults.vim|
- Improve the diff experience by updating the 'diffopt' default value to - Improve the diff mode experience by updating the 'diffopt' default value to
"internal,filler,closeoff,indent-heuristic,inline:char". "internal,filler,closeoff,indent-heuristic,inline:char".
Completion: ~ Completion: ~