runtime(doc): add package-<name> helptags for included packages
Commit:
https://github.com/vim/vim/commit/9598a6369bce32d3da831e8968caf4625985ac3c
Author: Christian Brabandt <c...@256bit.org>
Date: Sat Jan 11 10:14:24 2025 +0100
runtime(doc): add package-<name> helptags for included packages
Improve how to find the justify package
closes: #16420
Co-authored-by: Peter Benjamin <petermbenja...@gmail.com>
Signed-off-by: Christian Brabandt <c...@256bit.org>
diff --git a/runtime/doc/helphelp.txt b/runtime/doc/helphelp.txt
index 3ba092062..7b9dd7671 100644
--- a/runtime/doc/helphelp.txt
+++ b/runtime/doc/helphelp.txt
@@ -1,4 +1,4 @@
-*helphelp.txt* For Vim version 9.1. Last change: 2024 Dec 26
+*helphelp.txt* For Vim version 9.1. Last change: 2025 Jan 11
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -247,10 +247,10 @@ command: >
(requires write permission there): >
:helptags $VIMRUNTIME/doc
<
- *:HelpToc* *help-TOC* *help-toc-install*
+ *:HelpToc* *help-TOC* *help-toc-install* *package-helptoc*
If you want to access an interactive table of contents, from any position in
-the file, you can use the helptoc plugin. Load the plugin with: >
+the file, you can use the helptoc plugin. Load the plugin with: >vim
packadd helptoc
diff --git a/runtime/doc/quickfix.txt b/runtime/doc/quickfix.txt
index b6d79507f..834f0e1b6 100644
--- a/runtime/doc/quickfix.txt
+++ b/runtime/doc/quickfix.txt
@@ -1,4 +1,4 @@
-*quickfix.txt* For Vim version 9.1. Last change: 2024 Dec 27
+*quickfix.txt* For Vim version 9.1. Last change: 2025 Jan 11
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -550,9 +550,9 @@ EXECUTE A COMMAND IN ALL THE BUFFERS IN QUICKFIX OR
LOCATION LIST:
< Otherwise it works the same as `:ldo`.
FILTERING A QUICKFIX OR LOCATION LIST:
- *cfilter-plugin* *:Cfilter* *:Lfilter*
+ *cfilter-plugin* *:Cfilter* *:Lfilter* *package-cfilter*
If you have too many entries in a quickfix list, you can use the cfilter
-plugin to reduce the number of entries. Load the plugin with: >
+plugin to reduce the number of entries. Load the plugin with: >vim
packadd cfilter
diff --git a/runtime/doc/tags b/runtime/doc/tags
index a2996794f..2fc28d724 100644
--- a/runtime/doc/tags
+++ b/runtime/doc/tags
@@ -2129,6 +2129,7 @@ $quote eval.txt /*$quote*
:GnatTags ft_ada.txt /*:GnatTags*
:HelpToc helphelp.txt /*:HelpToc*
:Hexplore pi_netrw.txt /*:Hexplore*
+:Justify usr_25.txt /*:Justify*
:LP pi_logipat.txt /*:LP*
:LPE pi_logipat.txt /*:LPE*
:LPF pi_logipat.txt /*:LPF*
@@ -5567,6 +5568,7 @@ J change.txt /*J*
Japanese mbyte.txt /*Japanese*
Job eval.txt /*Job*
Jobs eval.txt /*Jobs*
+Justify() usr_25.txt /*Justify()*
K various.txt /*K*
KDE gui_x11.txt /*KDE*
KVim gui_x11.txt /*KVim*
@@ -8538,6 +8540,7 @@ jump-motions motion.txt /*jump-motions*
jumplist motion.txt /*jumplist*
jumplist-stack motion.txt /*jumplist-stack*
jumpto-diffs diff.txt /*jumpto-diffs*
+justify usr_25.txt /*justify*
k motion.txt /*k*
kcc uganda.txt /*kcc*
kde gui_x11.txt /*kde*
@@ -9384,9 +9387,17 @@ out_name channel.txt /*out_name*
out_timeout channel.txt /*out_timeout*
p change.txt /*p*
pack-add repeat.txt /*pack-add*
+package-cfilter quickfix.txt /*package-cfilter*
+package-comment usr_05.txt /*package-comment*
package-create repeat.txt /*package-create*
package-doc repeat.txt /*package-doc*
package-documentation repeat.txt /*package-documentation*
+package-editorconfig usr_05.txt /*package-editorconfig*
+package-helptoc helphelp.txt /*package-helptoc*
+package-justify usr_25.txt /*package-justify*
+package-matchit usr_05.txt /*package-matchit*
+package-nohlsearch usr_05.txt /*package-nohlsearch*
+package-termdebug terminal.txt /*package-termdebug*
package-translate_example repeat.txt /*package-translate_example*
package-translation repeat.txt /*package-translation*
packages repeat.txt /*packages*
diff --git a/runtime/doc/terminal.txt b/runtime/doc/terminal.txt
index 7e2d89824..1fcc470db 100644
--- a/runtime/doc/terminal.txt
+++ b/runtime/doc/terminal.txt
@@ -1,4 +1,4 @@
-*terminal.txt* For Vim version 9.1. Last change: 2024 Dec 30
+*terminal.txt* For Vim version 9.1. Last change: 2025 Jan 11
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -1254,7 +1254,7 @@ Alternatively, press "s" to swap the first and second
dump. Do this several
times so that you can spot the difference in the context of the text.
==============================================================================
-6. Debugging *terminal-debug* *terminal-debugger*
+6. Debugging *terminal-debug* *terminal-debugger* *package-termdebug*
The Terminal debugging plugin can be used to debug a program with gdb and view
the source code in a Vim window. Since this is completely contained inside
diff --git a/runtime/doc/usr_02.txt b/runtime/doc/usr_02.txt
index 70d24d3dd..a02835d86 100644
--- a/runtime/doc/usr_02.txt
+++ b/runtime/doc/usr_02.txt
@@ -1,4 +1,4 @@
-*usr_02.txt* For Vim version 9.1. Last change: 2024 Oct 05
+*usr_02.txt* For Vim version 9.1. Last change: 2025 Jan 11
VIM USER MANUAL - by Bram Moolenaar
@@ -694,6 +694,13 @@ Summary: *help-summary*
>
:help E128
< takes you to the |:function| command
+27) Documenction for packages distributed with Vim have the form
package-<name>.
+ So >
+ :help package-comment
+<
+ will bring you to the help section for the included comment plugin and how
to
+ enable it.
+
==============================================================================
diff --git a/runtime/doc/usr_05.txt b/runtime/doc/usr_05.txt
index ca6b91075..93231f6cd 100644
--- a/runtime/doc/usr_05.txt
+++ b/runtime/doc/usr_05.txt
@@ -1,4 +1,4 @@
-*usr_05.txt* For Vim version 9.1. Last change: 2024 Oct 05
+*usr_05.txt* For Vim version 9.1. Last change: 2025 Jan 11
VIM USER MANUAL - by Bram Moolenaar
@@ -392,7 +392,7 @@ The ":map" command (with no arguments) lists your current
mappings. At
least the ones for Normal mode. More about mappings in section |40.1|.
==============================================================================
-*05.5* Adding a package *add-package* *matchit-install*
+*05.5* Adding a package *add-package* *matchit-install* *package-matchit*
A package is a set of files that you can add to Vim. There are two kinds of
packages: optional and automatically loaded on startup.
@@ -427,7 +427,7 @@ an archive or as a repository. For an archive you can
follow these steps:
Here "fancytext" is the name of the package, it can be anything
else.
-Adding the editorconfig package
*editorconfig-install*
+Adding the editorconfig package *editorconfig-install* *package-editorconfig*
Similar to the matchit package, to load the distributed editorconfig plugin
when Vim starts, add the following line to your vimrc file: >
@@ -437,7 +437,7 @@ After restarting your Vim, the plugin is active and you can
read about it at: >
:h editorconfig.txt
-Adding comment package *comment-install*
+Adding comment package *comment-install* *package-comment*
Load the plugin with this command: >
packadd comment
@@ -450,7 +450,7 @@ the package loaded. Once the package is loaded, read about
it at: >
:h comment.txt
-Adding nohlsearch package *nohlsearch-install*
+Adding nohlsearch package *nohlsearch-install* *package-nohlsearch*
Load the plugin with this command: >
packadd nohlsearch
diff --git a/runtime/doc/usr_25.txt b/runtime/doc/usr_25.txt
index af013bcfe..5b4df0d0e 100644
--- a/runtime/doc/usr_25.txt
+++ b/runtime/doc/usr_25.txt
@@ -1,4 +1,4 @@
-*usr_25.txt* For Vim version 9.1. Last change: 2016 Mar 28
+*usr_25.txt* For Vim version 9.1. Last change: 2025 Jan 11
VIM USER MANUAL - by Bram Moolenaar
@@ -190,15 +190,15 @@ This results in the following:
story. ~
-JUSTIFYING TEXT
+JUSTIFYING TEXT *justify* *:Justify* *Justify()*
*package-justify*
Vim has no built-in way of justifying text. However, there is a neat macro
package that does the job. To use this package, execute the following
-command: >
+command: >vim
:packadd justify
-Or put this line in your |vimrc|: >
+Or put this line in your |vimrc|: >vim
packadd! justify
--
--
You received this message from the "vim_dev" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php
---
You received this message because you are subscribed to the Google Groups
"vim_dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to vim_dev+unsubscr...@googlegroups.com.
To view this discussion visit
https://groups.google.com/d/msgid/vim_dev/E1tWXoh-004UOO-5z%40256bit.org.
