]> git.ipfire.org Git - thirdparty/vim.git/commitdiff
runtime(doc): documentation updates
authorChristian Brabandt <cb@256bit.org>
Tue, 15 Aug 2023 22:11:09 +0000 (00:11 +0200)
committerChristian Brabandt <cb@256bit.org>
Mon, 11 Sep 2023 18:23:11 +0000 (20:23 +0200)
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>
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

index 535c17546ff2a99973bbd731ee962686b39ef71b..a8cb196e1a954f5081b18eff3b3fa46b74e01f5d 100644 (file)
@@ -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}])                  *job_start()*
                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: >
index 7b66303d3d9e8bdcd3fc9458a5b4583f4a66e3e8..b19c3067cb333f2bd3e85b7b9c63f58b8fb73cc2 100644 (file)
@@ -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 now, without the help of these people!
        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
index ec2b8756bf18792e4d8fb385739863e1684a8b39..6c82fa4959eb10d9059c014adc2fc8c74060ab3b 100644 (file)
@@ -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 remembered for each buffer.  This also
 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 differently:
        '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 short description can be found at |Q_op|.
 
                                                *'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 short description can be found at |Q_op|.
 
                                                *'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 short description can be found at |Q_op|.
 
                                        *'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 short description can be found at |Q_op|.
 
                                *'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 short description can be found at |Q_op|.
                                        *'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 short description can be found at |Q_op|.
 
                                   *'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 short description can be found at |Q_op|.
 
                                                *'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 short description can be found at |Q_op|.
 
                                                *'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 short description can be found at |Q_op|.
 
                        *'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 short description can be found at |Q_op|.
 
                        *'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.
index 6a20734a6099606a40ed675ea514ea74ec24b33e..fe560d380712ffcee9f991728479e4e610b710c8 100644 (file)
@@ -2160,11 +2160,11 @@ should set a variable in your .vimrc file: >
        :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
index 6c32c96cb84c7ea9c0f24ed9ad3ea2927e6a0e8f..846980bd13a8da961cef06af773ba3a36a7a6860 100644 (file)
@@ -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_chglog_format*
 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*
index 79b1574e22496a055dba85ad1e45805e1a9f4d4c..0dfddb255195ca4a3cc0904391be4e245db6eaf3 100644 (file)
@@ -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
index f43b239564bd16cc005c4d3790bbaa817f3d6511..0ab0301991ffd9eb7c4ad708b16826ab2d6424fd 100644 (file)
@@ -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
 
index e9549285ffce17b0525972e48df089b351abb8b5..95b766d6c841212a7210911efe68660f3750de6f 100644 (file)
@@ -44,12 +44,12 @@ He registered the vim.org domain and created the first Vim website.  We will
 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