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.
==============================================================================
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
@ -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)
start allow backspacing over the start of insert; CTRL-W and CTRL-U
stop once at the start of insert.
nostop like start, except CTRL-W and CTRL-U do not stop at the start of
insert.
nostop like start, except CTRL-W and CTRL-U do not stop at the start
of insert.
When the value is empty, Vi compatible backspacing is used, none of
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,
spaces must be escaped with a backslash ('\'), and commas with
double backslashes ('\\') (see |option-backslash|).
Unlike other sources, functions can provide completions starting
from a non-keyword character before the cursor, and their
start position for replacing text may differ from other sources.
If the Dict returned by the {func} includes {"refresh": "always"},
the function will be invoked again whenever the leading text
changes.
Unlike other sources, functions can provide completions
starting from a non-keyword character before the cursor, and
their start position for replacing text may differ from other
sources. If the Dict returned by the {func} includes
{"refresh": "always"}, the function will be invoked again
whenever the leading text changes.
If generating matches is potentially slow, call
|complete_check()| periodically to keep Vim responsive. This
is especially important for |ins-autocompletion|.
F equivalent to using "F{func}", where the function is taken from
the 'completefunc' option.
o equivalent to "F{func}", where {func} is taken from the 'omnifunc'
option. If a plugin (such as an LSP client) defines 'omnifunc', it
can be used through this flag.
F equivalent to using "F{func}", where the function is taken
from the 'completefunc' option.
o equivalent to "F{func}", where {func} is taken from the
'omnifunc' option. If a plugin (such as an LSP client)
defines 'omnifunc', it can be used through this flag.
Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
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
appending a caret ("^") followed by a {count} to the source flag.
For example: ".^9,w,u,t^5" limits matches from the current buffer
to 9 and from tags to 5. Other sources remain unlimited.
For example: ".^9,w,u,t^5" limits matches from the current buffer to 9
and from tags to 5. Other sources remain unlimited.
Note: The match limit takes effect only during forward completion
(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
{not available when compiled without the |+cscope|
feature}
In the absence of a prefix (-P) for cscope. setting this option enables
to use the basename of cscope.out path as the prefix.
In the absence of a prefix (-P) for cscope. setting this option
enables to use the basename of cscope.out path as the prefix.
See |cscoperelative|.
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.
*'dip'* *'diffopt'*
'diffopt' 'dip' string (default
"internal,filler,closeoff,indent-heuristic,inline:char")
'diffopt' 'dip' string (default "internal,filler,closeoff,
indent-heuristic,inline:char")
global
{not available when compiled without the |+diff|
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
noticeable lag. A reasonable setting is
"linematch:60", as this will enable alignment
for a 2 buffer diff hunk of 30 lines each,
or a 3 buffer diff hunk of 20 lines each.
for a 2 buffer diff hunk of 30 lines each, or
a 3 buffer diff hunk of 20 lines each.
Implicitly sets "filler" when this is set.
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
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,
screen flash or do nothing. See 'belloff' to finetune when to ring the
bell.
screen flash or do nothing. See 'belloff' to finetune when to ring
the bell.
*'errorfile'* *'ef'*
'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'.
'guitablabel' can be used to change the text in the labels.
When 'e' is missing a non-GUI tab pages line may be used.
The GUI tabs are only supported on some systems, currently
GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
The GUI tabs are only supported on some systems, currently GTK,
Motif, Mac OS/X, Haiku, and MS-Windows.
*'go-f'*
'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
@ -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
fit the highest line number in the buffer respectively the number of
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
up to 999. When the buffer has 1000 lines five columns will be used.
The minimum value is 1, the maximum value is 20.
is set. Thus with the Vim default of 4 there is room for a line
number up to 999. When the buffer has 1000 lines five columns will be
used. The minimum value is 1, the maximum value is 20.
NOTE: This option is set to the Vi default value when 'compatible' is
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
{only available when compiled with the |+python/dyn|
feature}
Specifies the name of the Python 2.x home directory. When 'pythonhome'
and the PYTHONHOME environment variable are not set, PYTHON_HOME,
which was specified at compile time, will be used for the Python 2.x
home directory.
Specifies the name of the Python 2.x home directory. When
'pythonhome' and the PYTHONHOME environment variable are not set,
PYTHON_HOME, which was specified at compile time, will be used for the
Python 2.x home directory.
Environment variables are expanded |:set_env|.
This option cannot be set from a |modeline| or in the |sandbox|, for
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
each line. Relative line numbers help you use the |count| you can
precede some vertical motion commands (e.g. j k + -) with, without
having to calculate it yourself. Especially useful in combination with
other commands (e.g. y d c < > gq gw =).
When the 'n' option is excluded from 'cpoptions' a wrapped
line will not use the column of line numbers (this is the default when
having to calculate it yourself. Especially useful in combination
with other commands (e.g. y d c < > gq gw =).
When the 'n' option is excluded from 'cpoptions' a wrapped line will
not use the column of line numbers (this is the default when
'compatible' isn't set).
The 'numberwidth' option can be used to set the room used for the line
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
changed when necessary. In this case, the jumplist will be populated
with the previous cursor position. For "screen", the text cannot always
be kept on the same screen line when 'wrap' is enabled.
with the previous cursor position. For "screen", the text cannot
always be kept on the same screen line when 'wrap' is enabled.
*'splitright'* *'spr'* *'nosplitright'* *'nospr'*
'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|
feature}
Defines variable-width tab stops. The value is a comma-separated list
of widths in columns. Each width defines the number of columns
before the next tab stop; the last value repeats indefinitely.
of widths in columns. Each width defines the number of columns before
the next tab stop; the last value repeats indefinitely.
For example: >
: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.
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
bells, e.g. on key repeat. This also happens without 'visualbell'
set.
having to wait for the flashing to finish when there are lots of bells,
e.g. on key repeat. This also happens without 'visualbell' set.
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",
@ -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
is not supported for file and directory names and
instead wildcard expansion is used.
pum Display the completion matches using the popup menu
in the same style as the |ins-completion-menu|.
pum Display the completion matches using the popup menu in
the same style as the |ins-completion-menu|.
tagfile When using CTRL-D to list matching tags, the kind of
tag and the file of the tag is listed. Only one match
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|
feature on MS-Windows}
Specifies the name of the winpty shared library, used for the
|:terminal| command. The default depends on whether Vim was built as a
32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
|:terminal| command. The default depends on whether Vim was built as
a 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
a fallback.
Environment variables are expanded |:set_env|.
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
@ -41670,7 +41670,7 @@ Default values: ~
- the default value for 'showcmd' is always enabled when using non-compatible
mode (previously, it was off on UNIX systems) and consequently removed from
|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".
Completion: ~