Skip to content

Commit 596ad66

Browse files
chrisbraHouldkearnsAdri Verhoef
committed
runtime(doc): documentation updates
This is a collection of various improvements to the help pages closes #12790 Co-authored-by: Houl <anwoku@yahoo.de> Co-authored-by: Doug Kearns <dougkearns@gmail.com> Co-authored-by: Adri Verhoef <a3@a3.xs4all.nl> Signed-off-by: Christian Brabandt <cb@256bit.org>
1 parent 62145db commit 596ad66

File tree

8 files changed

+29
-30
lines changed

8 files changed

+29
-30
lines changed

runtime/doc/channel.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*channel.txt* For Vim version 9.0. Last change: 2022 Dec 01
1+
*channel.txt* For Vim version 9.0. Last change: 2023 Aug 15
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -956,7 +956,7 @@ job_start({command} [, {options}]) *job_start()*
956956
to String. This works best on Unix.
957957

958958
On MS-Windows, job_start() makes a GUI application hidden. If
959-
want to show it, Use |:!start| instead.
959+
you want to show it, use |:!start| instead.
960960

961961
The command is executed directly, not through a shell, the
962962
'shell' option is not used. To use the shell: >

runtime/doc/intro.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*intro.txt* For Vim version 9.0. Last change: 2023 Aug 09
1+
*intro.txt* For Vim version 9.0. Last change: 2023 Aug 15
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -215,7 +215,7 @@ Vim would never have become what it is now, without the help of these people!
215215
Eric Fischer Mac port, 'cindent', and other improvements
216216
Benji Fisher Answering lots of user questions
217217
Bill Foster Athena GUI port (later removed)
218-
Google Lets me work on Vim one day a week
218+
Google Let Bram work on Vim one day a week
219219
Loic Grenie xvim (ideas for multi windows version)
220220
Sven Guckes Vim promoter and previous WWW page maintainer |Sven-Guckes|
221221
Darren Hiebert Exuberant ctags

runtime/doc/options.txt

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*options.txt* For Vim version 9.0. Last change: 2023 Jun 02
1+
*options.txt* For Vim version 9.0. Last change: 2023 Aug 15
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -303,7 +303,7 @@ The options local to a window are remembered for each buffer. This also
303303
happens when the buffer is not loaded, but they are lost when the buffer is
304304
wiped out |:bwipe|.
305305

306-
Special local window options *special-local-window-option*
306+
Special local window options *local-noglobal*
307307

308308
The following local window options won't be copied over when new windows are
309309
created, thus they behave slightly differently:
@@ -314,7 +314,7 @@ created, thus they behave slightly differently:
314314
'winfixheight' specific to existing window
315315
'winfixwidth' specific to existing window
316316

317-
Special local buffer options *special-local-buffer-option*
317+
Special local buffer options
318318

319319
The following local buffer options won't be copied over when new buffers are
320320
created, thus they behave slightly differently:
@@ -1474,7 +1474,7 @@ A jump table for the options with a short description can be found at |Q_op|.
14741474

14751475
*'bufhidden'* *'bh'*
14761476
'bufhidden' 'bh' string (default: "")
1477-
local to buffer |special-local-buffer-option|
1477+
local to buffer |local-noglobal|
14781478
This option specifies what happens when a buffer is no longer
14791479
displayed in a window:
14801480
<empty> follow the global 'hidden' option
@@ -1506,7 +1506,7 @@ A jump table for the options with a short description can be found at |Q_op|.
15061506

15071507
*'buftype'* *'bt'* *E382*
15081508
'buftype' 'bt' string (default: "")
1509-
local to buffer |special-local-buffer-option|
1509+
local to buffer |local-noglobal|
15101510
The value of this option specifies the type of a buffer:
15111511
<empty> normal buffer
15121512
nofile buffer which is not related to a file and will not be
@@ -3433,7 +3433,7 @@ A jump table for the options with a short description can be found at |Q_op|.
34333433

34343434
*'filetype'* *'ft'*
34353435
'filetype' 'ft' string (default: "")
3436-
local to buffer |special-local-buffer-option|
3436+
local to buffer |local-noglobal|
34373437
When this option is set, the FileType autocommand event is triggered.
34383438
All autocommands that match with the value of this option will be
34393439
executed. Thus the value of 'filetype' is used in place of the file
@@ -5590,7 +5590,7 @@ A jump table for the options with a short description can be found at |Q_op|.
55905590

55915591
*'modified'* *'mod'* *'nomodified'* *'nomod'*
55925592
'modified' 'mod' boolean (default off)
5593-
local to buffer |special-local-buffer-option|
5593+
local to buffer |local-noglobal|
55945594
When on, the buffer is considered to be modified. This option is set
55955595
when:
55965596
1. A change was made to the text since it was last written. Using the
@@ -6161,7 +6161,7 @@ A jump table for the options with a short description can be found at |Q_op|.
61616161
*'previewwindow'* *'nopreviewwindow'*
61626162
*'pvw'* *'nopvw'* *E590*
61636163
'previewwindow' 'pvw' boolean (default off)
6164-
local to window |special-local-window-option|
6164+
local to window |local-noglobal|
61656165
{not available when compiled without the |+quickfix|
61666166
feature}
61676167
Identifies the preview window. Only one window can have this option
@@ -6356,7 +6356,7 @@ A jump table for the options with a short description can be found at |Q_op|.
63566356

63576357
*'readonly'* *'ro'* *'noreadonly'* *'noro'*
63586358
'readonly' 'ro' boolean (default off)
6359-
local to buffer |special-local-buffer-option|
6359+
local to buffer |local-noglobal|
63606360
If on, writes fail unless you use a '!'. Protects you from
63616361
accidentally overwriting a file. Default on when Vim is started
63626362
in read-only mode ("vim -R") or when the executable is called "view".
@@ -6735,7 +6735,7 @@ A jump table for the options with a short description can be found at |Q_op|.
67356735

67366736
*'scroll'* *'scr'*
67376737
'scroll' 'scr' number (default: half the window height)
6738-
local to window |special-local-window-option|
6738+
local to window |local-noglobal|
67396739
Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
67406740
set to half the number of lines in the window when the window size
67416741
changes. This may happen when enabling the |status-line| or
@@ -7997,7 +7997,7 @@ A jump table for the options with a short description can be found at |Q_op|.
79977997

79987998
*'syntax'* *'syn'*
79997999
'syntax' 'syn' string (default empty)
8000-
local to buffer |special-local-buffer-option|
8000+
local to buffer |local-noglobal|
80018001
{not available when compiled without the |+syntax|
80028002
feature}
80038003
When this option is set, the syntax with this name is loaded, unless
@@ -9445,15 +9445,15 @@ A jump table for the options with a short description can be found at |Q_op|.
94459445

94469446
*'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
94479447
'winfixheight' 'wfh' boolean (default off)
9448-
local to window |special-local-window-option|
9448+
local to window |local-noglobal|
94499449
Keep the window height when windows are opened or closed and
94509450
'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
94519451
|preview-window| and |quickfix-window|.
94529452
The height may be changed anyway when running out of room.
94539453

94549454
*'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
94559455
'winfixwidth' 'wfw' boolean (default off)
9456-
local to window |special-local-window-option|
9456+
local to window |local-noglobal|
94579457
Keep the window width when windows are opened or closed and
94589458
'equalalways' is set. Also for |CTRL-W_=|.
94599459
The width may be changed anyway when running out of room.

runtime/doc/syntax.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2160,11 +2160,11 @@ should set a variable in your .vimrc file: >
21602160
:let lpc_syntax_for_c = 1
21612161
21622162
If it doesn't work properly for some particular C or LPC files, use a
2163-
modeline. For a LPC file:
2163+
modeline. For a LPC file: >
21642164
21652165
// vim:set ft=lpc:
21662166
2167-
For a C file that is recognized as LPC:
2167+
For a C file that is recognized as LPC: >
21682168
21692169
// vim:set ft=c:
21702170
@@ -2196,7 +2196,7 @@ LUA *lua.vim* *ft-lua-syntax*
21962196
The Lua syntax file can be used for versions 4.0, 5.0, 5.1 and 5.2 (5.2 is
21972197
the default). You can select one of these versions using the global variables
21982198
lua_version and lua_subversion. For example, to activate Lua
2199-
5.1 syntax highlighting, set the variables like this:
2199+
5.1 syntax highlighting, set the variables like this: >
22002200
22012201
:let lua_version = 5
22022202
:let lua_subversion = 1

runtime/doc/tags

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8345,6 +8345,7 @@ load-plugins starting.txt /*load-plugins*
83458345
load-vim-script repeat.txt /*load-vim-script*
83468346
local-additions help.txt /*local-additions*
83478347
local-function userfunc.txt /*local-function*
8348+
local-noglobal options.txt /*local-noglobal*
83488349
local-options options.txt /*local-options*
83498350
local-variable eval.txt /*local-variable*
83508351
local-variables userfunc.txt /*local-variables*
@@ -9732,8 +9733,6 @@ spec_chglog_format pi_spec.txt /*spec_chglog_format*
97329733
spec_chglog_prepend pi_spec.txt /*spec_chglog_prepend*
97339734
spec_chglog_release_info pi_spec.txt /*spec_chglog_release_info*
97349735
special-buffers windows.txt /*special-buffers*
9735-
special-local-buffer-option options.txt /*special-local-buffer-option*
9736-
special-local-window-option options.txt /*special-local-window-option*
97379736
specifies vim9class.txt /*specifies*
97389737
speed-up tips.txt /*speed-up*
97399738
spell spell.txt /*spell*

runtime/doc/tips.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*tips.txt* For Vim version 9.0. Last change: 2021 Nov 06
1+
*tips.txt* For Vim version 9.0. Last change: 2023 Aug 10
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar

runtime/doc/usr_05.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*usr_05.txt* For Vim version 9.0. Last change: 2019 May 23
1+
*usr_05.txt* For Vim version 9.0. Last change: 2023 Aug 10
22

33
VIM USER MANUAL - by Bram Moolenaar
44

runtime/doc/version9.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,12 @@ He registered the vim.org domain and created the first Vim website. We will
4444
remember him!
4545

4646
*Bram* *Moolenaar* *Bram-Moolenaar*
47-
Vim version 9.1 is dedicated to Bram Moolenaar, who passed away on August 3rd 2023
48-
while still working full-time on Vim. The Vim project would not exist without
49-
his ongoing passion to lead and develop Vim and the community for more than 30
50-
years. Bram was also passionate about his |ICCF| foundation to help children
51-
in Uganda. If you enjoy using Vim, please consider donating!
52-
We will miss his guidance, passion and leadership.
47+
Vim version 9.1 is dedicated to Bram Moolenaar, who passed away on August 3rd
48+
2023 while still working full-time on Vim. The Vim project would not exist
49+
without his ongoing passion to lead and develop Vim and the community for more
50+
than 30 years. Bram was also passionate about his |ICCF| foundation to help
51+
children in Uganda. If you enjoy using Vim, please consider donating! We will
52+
miss his guidance, passion and leadership.
5353

5454
Obituary Articles: https://github.com/vim/vim/discussions/12742
5555
Say Farewell: https://github.com/vim/vim/discussions/12737

0 commit comments

Comments
 (0)