changeset 33253:3bc84e3fd05c

runtime(doc): documentation updates Commit: https://github.com/vim/vim/commit/596ad66d1ddb742ef349e98eb06b8e4052f68f51 Author: Christian Brabandt <cb@256bit.org> Date: Wed Aug 16 00:11:09 2023 +0200 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>
author Christian Brabandt <cb@256bit.org>
date Mon, 11 Sep 2023 20:30:03 +0200
parents 76d9597780ce
children d4a558720faf
files runtime/doc/channel.txt runtime/doc/intro.txt runtime/doc/options.txt runtime/doc/syntax.txt runtime/doc/tags runtime/doc/tips.txt runtime/doc/usr_05.txt runtime/doc/version9.txt
diffstat 8 files changed, 29 insertions(+), 30 deletions(-) [+]
line wrap: on
line diff
--- a/runtime/doc/channel.txt
+++ b/runtime/doc/channel.txt
@@ -1,4 +1,4 @@
-*channel.txt*      For Vim version 9.0.  Last change: 2022 Dec 01
+*channel.txt*      For Vim version 9.0.  Last change: 2023 Aug 15
 
 
 		  VIM REFERENCE MANUAL	  by Bram Moolenaar
@@ -956,7 +956,7 @@ job_start({command} [, {options}])			*jo
 		to String.  This works best on Unix.
 
 		On MS-Windows, job_start() makes a GUI application hidden. If
-		want to show it, Use |:!start| instead.
+		you want to show it, use |:!start| instead.
 
 		The command is executed directly, not through a shell, the
 		'shell' option is not used.  To use the shell: >
--- a/runtime/doc/intro.txt
+++ b/runtime/doc/intro.txt
@@ -1,4 +1,4 @@
-*intro.txt*     For Vim version 9.0.  Last change: 2023 Aug 09
+*intro.txt*     For Vim version 9.0.  Last change: 2023 Aug 15
 
 
 		  VIM REFERENCE MANUAL    by Bram Moolenaar
@@ -215,7 +215,7 @@ Vim would never have become what it is n
 	Eric Fischer		Mac port, 'cindent', and other improvements
 	Benji Fisher		Answering lots of user questions
 	Bill Foster		Athena GUI port (later removed)
-	Google			Lets me work on Vim one day a week
+	Google			Let Bram work on Vim one day a week
 	Loic Grenie		xvim (ideas for multi windows version)
 	Sven Guckes		Vim promoter and previous WWW page maintainer |Sven-Guckes|
 	Darren Hiebert		Exuberant ctags
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -1,4 +1,4 @@
-*options.txt*	For Vim version 9.0.  Last change: 2023 Jun 02
+*options.txt*	For Vim version 9.0.  Last change: 2023 Aug 15
 
 
 		  VIM REFERENCE MANUAL	  by Bram Moolenaar
@@ -303,7 +303,7 @@ The options local to a window are rememb
 happens when the buffer is not loaded, but they are lost when the buffer is
 wiped out |:bwipe|.
 
-Special local window options			*special-local-window-option*
+Special local window options			*local-noglobal*
 
 The following local window options won't be copied over when new windows are
 created, thus they behave slightly differently:
@@ -314,7 +314,7 @@ created, thus they behave slightly diffe
 	'winfixheight'	specific to existing window
 	'winfixwidth'	specific to existing window
 
-Special local buffer options			*special-local-buffer-option*
+Special local buffer options
 
 The following local buffer options won't be copied over when new buffers are
 created, thus they behave slightly differently:
@@ -1474,7 +1474,7 @@ A jump table for the options with a shor
 
 						*'bufhidden'* *'bh'*
 'bufhidden' 'bh'	string (default: "")
-			local to buffer  |special-local-buffer-option|
+			local to buffer  |local-noglobal|
 	This option specifies what happens when a buffer is no longer
 	displayed in a window:
 	  <empty>	follow the global 'hidden' option
@@ -1506,7 +1506,7 @@ A jump table for the options with a shor
 
 						*'buftype'* *'bt'* *E382*
 'buftype' 'bt'		string (default: "")
-			local to buffer  |special-local-buffer-option|
+			local to buffer  |local-noglobal|
 	The value of this option specifies the type of a buffer:
 	  <empty>	normal buffer
 	  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 shor
 
 					*'filetype'* *'ft'*
 'filetype' 'ft'		string (default: "")
-			local to buffer  |special-local-buffer-option|
+			local to buffer  |local-noglobal|
 	When this option is set, the FileType autocommand event is triggered.
 	All autocommands that match with the value of this option will be
 	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 shor
 
 				*'modified'* *'mod'* *'nomodified'* *'nomod'*
 'modified' 'mod'	boolean	(default off)
-			local to buffer  |special-local-buffer-option|
+			local to buffer  |local-noglobal|
 	When on, the buffer is considered to be modified.  This option is set
 	when:
 	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 shor
 					*'previewwindow'* *'nopreviewwindow'*
 					*'pvw'* *'nopvw'* *E590*
 'previewwindow' 'pvw'	boolean (default off)
-			local to window  |special-local-window-option|
+			local to window  |local-noglobal|
 			{not available when compiled without the |+quickfix|
 			feature}
 	Identifies the preview window.  Only one window can have this option
@@ -6356,7 +6356,7 @@ A jump table for the options with a shor
 
 				   *'readonly'* *'ro'* *'noreadonly'* *'noro'*
 'readonly' 'ro'		boolean	(default off)
-			local to buffer  |special-local-buffer-option|
+			local to buffer  |local-noglobal|
 	If on, writes fail unless you use a '!'.  Protects you from
 	accidentally overwriting a file.  Default on when Vim is started
 	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 shor
 
 						*'scroll'* *'scr'*
 'scroll' 'scr'		number	(default: half the window height)
-			local to window  |special-local-window-option|
+			local to window  |local-noglobal|
 	Number of lines to scroll with CTRL-U and CTRL-D commands.  Will be
 	set to half the number of lines in the window when the window size
 	changes.  This may happen when enabling the |status-line| or
@@ -7997,7 +7997,7 @@ A jump table for the options with a shor
 
 						*'syntax'* *'syn'*
 'syntax' 'syn'		string	(default empty)
-			local to buffer  |special-local-buffer-option|
+			local to buffer  |local-noglobal|
 			{not available when compiled without the |+syntax|
 			feature}
 	When this option is set, the syntax with this name is loaded, unless
@@ -9445,7 +9445,7 @@ A jump table for the options with a shor
 
 			*'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
 'winfixheight' 'wfh'	boolean	(default off)
-			local to window  |special-local-window-option|
+			local to window  |local-noglobal|
 	Keep the window height when windows are opened or closed and
 	'equalalways' is set.  Also for |CTRL-W_=|.  Set by default for the
 	|preview-window| and |quickfix-window|.
@@ -9453,7 +9453,7 @@ A jump table for the options with a shor
 
 			*'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
 'winfixwidth' 'wfw'	boolean	(default off)
-			local to window  |special-local-window-option|
+			local to window  |local-noglobal|
 	Keep the window width when windows are opened or closed and
 	'equalalways' is set.  Also for |CTRL-W_=|.
 	The width may be changed anyway when running out of room.
--- a/runtime/doc/syntax.txt
+++ b/runtime/doc/syntax.txt
@@ -2160,11 +2160,11 @@ should set a variable in your .vimrc fil
 	:let lpc_syntax_for_c = 1
 
 If it doesn't work properly for some particular C or LPC files, use a
-modeline.  For a LPC file:
+modeline.  For a LPC file: >
 
 	// vim:set ft=lpc:
 
-For a C file that is recognized as LPC:
+For a C file that is recognized as LPC: >
 
 	// vim:set ft=c:
 
@@ -2196,7 +2196,7 @@ LUA						*lua.vim* *ft-lua-syntax*
 The Lua syntax file can be used for versions 4.0, 5.0, 5.1 and 5.2 (5.2 is
 the default). You can select one of these versions using the global variables
 lua_version and lua_subversion. For example, to activate Lua
-5.1 syntax highlighting, set the variables like this:
+5.1 syntax highlighting, set the variables like this: >
 
 	:let lua_version = 5
 	:let lua_subversion = 1
--- a/runtime/doc/tags
+++ b/runtime/doc/tags
@@ -8345,6 +8345,7 @@ load-plugins	starting.txt	/*load-plugins
 load-vim-script	repeat.txt	/*load-vim-script*
 local-additions	help.txt	/*local-additions*
 local-function	userfunc.txt	/*local-function*
+local-noglobal	options.txt	/*local-noglobal*
 local-options	options.txt	/*local-options*
 local-variable	eval.txt	/*local-variable*
 local-variables	userfunc.txt	/*local-variables*
@@ -9732,8 +9733,6 @@ spec_chglog_format	pi_spec.txt	/*spec_ch
 spec_chglog_prepend	pi_spec.txt	/*spec_chglog_prepend*
 spec_chglog_release_info	pi_spec.txt	/*spec_chglog_release_info*
 special-buffers	windows.txt	/*special-buffers*
-special-local-buffer-option	options.txt	/*special-local-buffer-option*
-special-local-window-option	options.txt	/*special-local-window-option*
 specifies	vim9class.txt	/*specifies*
 speed-up	tips.txt	/*speed-up*
 spell	spell.txt	/*spell*
--- a/runtime/doc/tips.txt
+++ b/runtime/doc/tips.txt
@@ -1,4 +1,4 @@
-*tips.txt*      For Vim version 9.0.  Last change: 2021 Nov 06
+*tips.txt*      For Vim version 9.0.  Last change: 2023 Aug 10
 
 
 		  VIM REFERENCE MANUAL    by Bram Moolenaar
--- a/runtime/doc/usr_05.txt
+++ b/runtime/doc/usr_05.txt
@@ -1,4 +1,4 @@
-*usr_05.txt*	For Vim version 9.0.  Last change: 2019 May 23
+*usr_05.txt*	For Vim version 9.0.  Last change: 2023 Aug 10
 
 		     VIM USER MANUAL - by Bram Moolenaar
 
--- a/runtime/doc/version9.txt
+++ b/runtime/doc/version9.txt
@@ -44,12 +44,12 @@ He registered the vim.org domain and cre
 remember him!
 
 						 *Bram* *Moolenaar* *Bram-Moolenaar*
-Vim version 9.1 is dedicated to Bram Moolenaar, who passed away on August 3rd 2023
-while still working full-time on Vim.  The Vim project would not exist without
-his ongoing passion to lead and develop Vim and the community for more than 30
-years.  Bram was also passionate about his |ICCF| foundation to help children
-in Uganda.  If you enjoy using Vim, please consider donating!
-We will miss his guidance, passion and leadership.
+Vim version 9.1 is dedicated to Bram Moolenaar, who passed away on August 3rd
+2023 while still working full-time on Vim.  The Vim project would not exist
+without his ongoing passion to lead and develop Vim and the community for more
+than 30 years.  Bram was also passionate about his |ICCF| foundation to help
+children in Uganda.  If you enjoy using Vim, please consider donating! We will
+miss his guidance, passion and leadership.
 
 Obituary Articles: https://github.com/vim/vim/discussions/12742
 Say Farewell: https://github.com/vim/vim/discussions/12737