]> git.ipfire.org Git - thirdparty/vim.git/commitdiff
runtime(doc): make examples verbatim to prevent conceal/tag parsing
authorYochem van Rosmalen <git@yochem.nl>
Tue, 3 Jun 2025 18:54:33 +0000 (20:54 +0200)
committerChristian Brabandt <cb@256bit.org>
Tue, 3 Jun 2025 18:54:33 +0000 (20:54 +0200)
closes: #17437

Signed-off-by: Yochem van Rosmalen <git@yochem.nl>
Signed-off-by: Christian Brabandt <cb@256bit.org>
runtime/doc/editing.txt
runtime/doc/helphelp.txt
runtime/doc/syntax.txt
runtime/doc/usr_02.txt
runtime/doc/usr_11.txt
runtime/doc/usr_22.txt

index a88aad1a7fa4eefb3ca71da5f7bca6689a075ac1..faef9ec6213189b6170b2add50c100a19f2ca14e 100644 (file)
@@ -1,4 +1,4 @@
-*editing.txt*   For Vim version 9.1.  Last change: 2025 Apr 03
+*editing.txt*   For Vim version 9.1.  Last change: 2025 Jun 03
 
 
                  VIM REFERENCE MANUAL    by Bram Moolenaar
@@ -1342,9 +1342,15 @@ b:browsefilter variable.  You would most likely set b:browsefilter in a
 filetype plugin, so that the browse dialog would contain entries related to
 the type of file you are currently editing.  Disadvantage: This makes it
 difficult to start editing a file of a different type.  To overcome this, you
-may want to add "All Files (*.*)\t*\n" as the final filter on Windows or "All
-Files (*)\t*\n" on other platforms, so that the user can still access any
-desired file.
+may want to add >
+
+       All Files\t(*.*)\t*\n
+<
+as the final filter on Windows or >
+
+       All Files\t(*)\t*\n"
+<
+on other platforms, so that the user can still access any desired file.
 
 To avoid setting browsefilter when Vim does not actually support it, you can
 use has("browsefilter"): >
index 4af6efd2d75a7f62c4816e6e297cb6e086d68720..c49a4d50b5de906dea16d0d22f0e51858a08bf4a 100644 (file)
@@ -1,4 +1,4 @@
-*helphelp.txt* For Vim version 9.1.  Last change: 2025 May 31
+*helphelp.txt* For Vim version 9.1.  Last change: 2025 Jun 03
 
 
                  VIM REFERENCE MANUAL    by Bram Moolenaar
@@ -412,7 +412,7 @@ in such a modeline, that can have undesired consequences.
 
 TAGS
 
-To define a help tag, place the name between asterisks (*tag-name*).  The
+To define a help tag, place the name between asterisks ("*tag-name*").  The
 tag-name should be different from all the Vim help tag names and ideally
 should begin with the name of the Vim plugin.  The tag name is usually right
 aligned on a line.
index a23b892e5b0ac04b55c850bdf0289570af4142c1..44fed277ff49fad24a91ec23443e9df28d34c05c 100644 (file)
@@ -1,4 +1,4 @@
-*syntax.txt*   For Vim version 9.1.  Last change: 2025 Jun 01
+*syntax.txt*   For Vim version 9.1.  Last change: 2025 Jun 03
 
 
                  VIM REFERENCE MANUAL    by Bram Moolenaar
@@ -3102,7 +3102,7 @@ PRINTCAP + TERMCAP        *ft-ptcap-syntax* *ft-termcap-syntax*
 This syntax file applies to the printcap and termcap databases.
 
 In order for Vim to recognize printcap/termcap files that do not match
-the patterns *printcap*, or *termcap*, you must put additional patterns
+the patterns "*printcap*", or "*termcap*", you must put additional patterns
 appropriate to your system in your |myfiletypefile| file.  For these
 patterns, you must set the variable "b:ptcap_type" to either "print" or
 "term", and then the 'filetype' option to ptcap.
index e52853a820f5843972f5e3e787d3491778ed5ed2..af1cd619b8a90bd1ab03207775dce152f9745ef9 100644 (file)
@@ -1,4 +1,4 @@
-*usr_02.txt*   For Vim version 9.1.  Last change: 2025 Feb 01
+*usr_02.txt*   For Vim version 9.1.  Last change: 2025 Jun 03
 
                     VIM USER MANUAL - by Bram Moolenaar
 
@@ -438,9 +438,9 @@ of the tag given by the word under the cursor.)
    After a few jumps, you might want to go back.  CTRL-T (pop tag) takes you
 back to the preceding position.  CTRL-O (jump to older position) also works
 nicely here.
-   At the top of the help screen, there is the notation *help.txt*.  This name
-between "*" characters is used by the help system to define a tag (hyperlink
-destination).
+   At the top of the help screen, there is the notation "*help.txt*".  This
+name between "*" characters is used by the help system to define a tag
+(hyperlink destination).
    See |29.1| for details about using tags.
 
 To get help on a given subject, use the following command: >
index 9ba6f4420e6988bf0d0742484bc515b7deb197fd..19851b5306a07d47373d35df5b6b0158eac6278b 100644 (file)
@@ -1,4 +1,4 @@
-*usr_11.txt*   For Vim version 9.1.  Last change: 2020 Oct 25
+*usr_11.txt*   For Vim version 9.1.  Last change: 2025 Jun 03
 
                     VIM USER MANUAL - by Bram Moolenaar
 
@@ -127,7 +127,7 @@ Example: >
        vim -r .help.txt.swo
 
 This is also handy when the swap file is in another directory than expected.
-Vim recognizes files with the pattern *.s[uvw][a-z] as swap files.
+Vim recognizes files with the pattern "*.s[uvw][a-z]" as swap files.
 
 If this still does not work, see what file names Vim reports and rename the
 files accordingly.  Check the 'directory' option to see where Vim may have
index 0220893a798cfe28bcc05def06713bc526a20cd2..c6bc5d233ab090ccc651ad4b00de7cde662fef6a 100644 (file)
@@ -1,4 +1,4 @@
-*usr_22.txt*   For Vim version 9.1.  Last change: 2024 Oct 05
+*usr_22.txt*   For Vim version 9.1.  Last change: 2025 Jun 03
 
                     VIM USER MANUAL - by Bram Moolenaar
 
@@ -27,23 +27,23 @@ Vim has a plugin that makes it possible to edit a directory.  Try this: >
        :edit .
 
 Through the magic of autocommands and Vim scripts, the window will be filled
-with the contents of the directory.  It looks like this:
-
-" ============================================================================ ~
-" Netrw Directory Listing                                        (netrw v109) ~
-"   Sorted by      name ~
-"   Sort sequence: [\/]$,\.h$,\.c$,\.cpp$,*,\.info$,\.swp$,\.o$\.obj$,\.bak$ ~
-"   Quick Help: <F1>:help  -:go up dir  D:delete  R:rename  s:sort-by  x:exec ~
-" ============================================================================ ~
-../ ~
-./ ~
-check/ ~
-Makefile ~
-autocmd.txt ~
-change.txt ~
-eval.txt ~
-filetype.txt ~
-help.txt.info ~
+with the contents of the directory.  It looks like this: >
+
+  " ===========================================================================
+  " Netrw Directory Listing                                        (netrw v109)
+  "   Sorted by      name
+  "   Sort sequence: [\/]$,\.h$,\.c$,\.cpp$,*,\.info$,\.swp$,\.o$\.obj$,\.bak$
+  "   Quick Help: <F1>:help  -:go up dir  D:delete  R:rename  s:sort-by  x:exec
+  " ===========================================================================
+  ../
+  ./
+  check/
+  Makefile
+  autocmd.txt
+  change.txt
+  eval.txt
+  filetype.txt
+  help.txt.info
 
 You can see these items: