changeset 33257:f2e65ef623e8

runtime(help): Updated documentation on editorconfig Commit: https://github.com/vim/vim/commit/6ffcc58be32aa1b337bc839cfe173b68cfde7085 Author: Christian Brabandt <cb@256bit.org> Date: Tue Sep 12 21:08:54 2023 +0200 runtime(help): Updated documentation on editorconfig Add a small section about the distributed Editorconfig plugin at :h usr_05.txt just below the matchit plugin. While editing that help document, also add a bit of more documentation about standard plugins and local help file additions. Regenerate $VIMRUNTIME/doc/tags file with all the new tags from the rust runtime files. While at it, update the Editorconfig help page (and re-generate the helptags file). closes: #13078 Signed-off-by: Christian Brabandt <cb@256bit.org>
author Christian Brabandt <cb@256bit.org>
date Tue, 12 Sep 2023 21:15:03 +0200
parents dbbd695cf236
children 5b95bef071c0
files runtime/doc/tags runtime/doc/usr_05.txt runtime/pack/dist/opt/editorconfig/doc/editorconfig.txt runtime/pack/dist/opt/editorconfig/doc/tags
diffstat 4 files changed, 92 insertions(+), 34 deletions(-) [+]
line wrap: on
line diff
--- a/runtime/doc/tags
+++ b/runtime/doc/tags
@@ -2075,7 +2075,14 @@ 90.5	usr_90.txt	/*90.5*
 :Arguments	terminal.txt	/*:Arguments*
 :Asm	terminal.txt	/*:Asm*
 :Break	terminal.txt	/*:Break*
+:Cargo	ft_rust.txt	/*:Cargo*
+:Cbench	ft_rust.txt	/*:Cbench*
+:Cbuild	ft_rust.txt	/*:Cbuild*
+:Cclean	ft_rust.txt	/*:Cclean*
+:Cdoc	ft_rust.txt	/*:Cdoc*
 :Cfilter	quickfix.txt	/*:Cfilter*
+:Cinit	ft_rust.txt	/*:Cinit*
+:Cinstall	ft_rust.txt	/*:Cinstall*
 :Clear	terminal.txt	/*:Clear*
 :CompilerSet	usr_51.txt	/*:CompilerSet*
 :ConTeXt	ft_context.txt	/*:ConTeXt*
@@ -2083,6 +2090,12 @@ 90.5	usr_90.txt	/*90.5*
 :ConTeXtLog	ft_context.txt	/*:ConTeXtLog*
 :ConTeXtStopJobs	ft_context.txt	/*:ConTeXtStopJobs*
 :Continue	terminal.txt	/*:Continue*
+:Cpublish	ft_rust.txt	/*:Cpublish*
+:Crun	ft_rust.txt	/*:Crun*
+:Cruntarget	ft_rust.txt	/*:Cruntarget*
+:Csearch	ft_rust.txt	/*:Csearch*
+:Ctest	ft_rust.txt	/*:Ctest*
+:Cupdate	ft_rust.txt	/*:Cupdate*
 :DiffOrig	diff.txt	/*:DiffOrig*
 :DoMatchParen	pi_paren.txt	/*:DoMatchParen*
 :Down	terminal.txt	/*:Down*
@@ -2131,8 +2144,12 @@ 90.5	usr_90.txt	/*90.5*
 :RustExpand	ft_rust.txt	/*:RustExpand*
 :RustFmt	ft_rust.txt	/*:RustFmt*
 :RustFmtRange	ft_rust.txt	/*:RustFmtRange*
+:RustInfo	ft_rust.txt	/*:RustInfo*
+:RustInfoClipboard	ft_rust.txt	/*:RustInfoClipboard*
+:RustInfoToFile	ft_rust.txt	/*:RustInfoToFile*
 :RustPlay	ft_rust.txt	/*:RustPlay*
 :RustRun	ft_rust.txt	/*:RustRun*
+:RustTest	ft_rust.txt	/*:RustTest*
 :Sexplore	pi_netrw.txt	/*:Sexplore*
 :Source	terminal.txt	/*:Source*
 :Step	terminal.txt	/*:Step*
@@ -5998,6 +6015,13 @@ b:clojure_syntax_keywords	syntax.txt	/*b
 b:clojure_syntax_without_core_keywords	syntax.txt	/*b:clojure_syntax_without_core_keywords*
 b:current_syntax-variable	syntax.txt	/*b:current_syntax-variable*
 b:netrw_lastfile	pi_netrw.txt	/*b:netrw_lastfile*
+b:rust_cargo_avoid_whole_workspace	ft_rust.txt	/*b:rust_cargo_avoid_whole_workspace*
+b:rust_cargo_check_all_features	ft_rust.txt	/*b:rust_cargo_check_all_features*
+b:rust_cargo_check_all_targets	ft_rust.txt	/*b:rust_cargo_check_all_targets*
+b:rust_cargo_check_benches	ft_rust.txt	/*b:rust_cargo_check_benches*
+b:rust_cargo_check_examples	ft_rust.txt	/*b:rust_cargo_check_examples*
+b:rust_cargo_check_tests	ft_rust.txt	/*b:rust_cargo_check_tests*
+b:rustfmt_autosave	ft_rust.txt	/*b:rustfmt_autosave*
 b:tex_stylish	syntax.txt	/*b:tex_stylish*
 b:var	eval.txt	/*b:var*
 b:yaml_schema	syntax.txt	/*b:yaml_schema*
@@ -6693,6 +6717,7 @@ dis	motion.txt	/*dis*
 disable-menus	gui.txt	/*disable-menus*
 discard	editing.txt	/*discard*
 distribute-script	usr_51.txt	/*distribute-script*
+distributed-plugins	usr_05.txt	/*distributed-plugins*
 distribution	intro.txt	/*distribution*
 diw	motion.txt	/*diw*
 dl	change.txt	/*dl*
@@ -6742,6 +6767,7 @@ edit-no-break	usr_25.txt	/*edit-no-break
 edit-paragraph-join	usr_25.txt	/*edit-paragraph-join*
 edit-window	windows.txt	/*edit-window*
 editing.txt	editing.txt	/*editing.txt*
+editorconfig-install	usr_05.txt	/*editorconfig-install*
 efm-%>	quickfix.txt	/*efm-%>*
 efm-entries	quickfix.txt	/*efm-entries*
 efm-ignore	quickfix.txt	/*efm-ignore*
@@ -7321,6 +7347,8 @@ g:ada_space_errors	ft_ada.txt	/*g:ada_sp
 g:ada_standard_types	ft_ada.txt	/*g:ada_standard_types*
 g:ada_with_gnat_project_files	ft_ada.txt	/*g:ada_with_gnat_project_files*
 g:ada_withuse_ordinary	ft_ada.txt	/*g:ada_withuse_ordinary*
+g:cargo_makeprg_params	ft_rust.txt	/*g:cargo_makeprg_params*
+g:cargo_shell_command_runner	ft_rust.txt	/*g:cargo_shell_command_runner*
 g:clojure_align_multiline_strings	indent.txt	/*g:clojure_align_multiline_strings*
 g:clojure_align_subforms	indent.txt	/*g:clojure_align_subforms*
 g:clojure_discard_macro	syntax.txt	/*g:clojure_discard_macro*
@@ -7485,17 +7513,27 @@ g:no_mail_maps	filetype.txt	/*g:no_mail_
 g:no_plugin_maps	filetype.txt	/*g:no_plugin_maps*
 g:plugin_exec	filetype.txt	/*g:plugin_exec*
 g:rust_bang_comment_leader	ft_rust.txt	/*g:rust_bang_comment_leader*
+g:rust_cargo_avoid_whole_workspace	ft_rust.txt	/*g:rust_cargo_avoid_whole_workspace*
+g:rust_cargo_check_all_features	ft_rust.txt	/*g:rust_cargo_check_all_features*
+g:rust_cargo_check_all_targets	ft_rust.txt	/*g:rust_cargo_check_all_targets*
+g:rust_cargo_check_benches	ft_rust.txt	/*g:rust_cargo_check_benches*
+g:rust_cargo_check_examples	ft_rust.txt	/*g:rust_cargo_check_examples*
+g:rust_cargo_check_tests	ft_rust.txt	/*g:rust_cargo_check_tests*
+g:rust_clip_command	ft_rust.txt	/*g:rust_clip_command*
 g:rust_conceal	ft_rust.txt	/*g:rust_conceal*
 g:rust_conceal_mod_path	ft_rust.txt	/*g:rust_conceal_mod_path*
 g:rust_conceal_pub	ft_rust.txt	/*g:rust_conceal_pub*
 g:rust_fold	ft_rust.txt	/*g:rust_fold*
-g:rust_playpen_url	ft_rust.txt	/*g:rust_playpen_url*
+g:rust_keep_autopairs_default	ft_rust.txt	/*g:rust_keep_autopairs_default*
 g:rust_recommended_style	ft_rust.txt	/*g:rust_recommended_style*
 g:rust_shortener_url	ft_rust.txt	/*g:rust_shortener_url*
+g:rust_use_custom_ctags_defs	ft_rust.txt	/*g:rust_use_custom_ctags_defs*
 g:rustc_makeprg_no_percent	ft_rust.txt	/*g:rustc_makeprg_no_percent*
 g:rustc_path	ft_rust.txt	/*g:rustc_path*
 g:rustfmt_autosave	ft_rust.txt	/*g:rustfmt_autosave*
+g:rustfmt_autosave_if_config_present	ft_rust.txt	/*g:rustfmt_autosave_if_config_present*
 g:rustfmt_command	ft_rust.txt	/*g:rustfmt_command*
+g:rustfmt_emit_files	ft_rust.txt	/*g:rustfmt_emit_files*
 g:rustfmt_fail_silently	ft_rust.txt	/*g:rustfmt_fail_silently*
 g:rustfmt_options	ft_rust.txt	/*g:rustfmt_options*
 g:statusline_winid	options.txt	/*g:statusline_winid*
@@ -9515,12 +9553,12 @@ russian-keymap	russian.txt	/*russian-key
 russian-l18n	russian.txt	/*russian-l18n*
 russian.txt	russian.txt	/*russian.txt*
 rust	ft_rust.txt	/*rust*
+rust-auto-pairs	ft_rust.txt	/*rust-auto-pairs*
 rust-commands	ft_rust.txt	/*rust-commands*
 rust-intro	ft_rust.txt	/*rust-intro*
 rust-mappings	ft_rust.txt	/*rust-mappings*
 rust-settings	ft_rust.txt	/*rust-settings*
-rust_<D-R>	ft_rust.txt	/*rust_<D-R>*
-rust_<D-r>	ft_rust.txt	/*rust_<D-r>*
+rust-syntastic	ft_rust.txt	/*rust-syntastic*
 rview	starting.txt	/*rview*
 rvim	starting.txt	/*rvim*
 rxvt	syntax.txt	/*rxvt*
--- 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: 2023 Aug 10
+*usr_05.txt*	For Vim version 9.0.  Last change: 2023 Sep 12
 
 		     VIM USER MANUAL - by Bram Moolenaar
 
@@ -427,6 +427,15 @@ an archive or as a repository.  For an a
 	   Here "fancytext" is the name of the package, it can be anything
 	   else.
 
+Adding the editorconfig package				*editorconfig-install*
+
+Similar to the matchit package, to load the distributed editorconfig plugin
+when Vim starts, add the following line to your vimrc file: >
+	packadd! editorconfig
+
+After restarting your Vim, the plugin is active and you can read about it at: >
+	:h editorconfig.txt
+
 More information about packages can be found here: |packages|.
 
 ==============================================================================
@@ -446,13 +455,18 @@ The global plugins will be discussed fir
 |add-filetype-plugin|.
 
 
-GLOBAL PLUGINS						*standard-plugin*
+GLOBAL PLUGINS				*standard-plugin* *distributed-plugins*
 
 When you start Vim, it will automatically load a number of global plugins.
 You don't have to do anything for this.  They add functionality that most
 people will want to use, but which was implemented as a Vim script instead of
 being compiled into Vim.  You can find them listed in the help index
-|standard-plugin-list|.  Also see |load-plugins|.
+|standard-plugin-list|.
+
+For locally installed plugins and packages (which come with a separated help
+file) a similar list can be found in the help section |local-additions|.
+
+Also see |load-plugins|.
 
 							*add-global-plugin*
 You can add a global plugin to add functionality that will always be present
--- a/runtime/pack/dist/opt/editorconfig/doc/editorconfig.txt
+++ b/runtime/pack/dist/opt/editorconfig/doc/editorconfig.txt
@@ -1,36 +1,10 @@
-*editorconfig.txt*   EditorConfig plugin for Vim
+*editorconfig.txt*            EditorConfig plugin for vim.
 
 File: editorconfig.txt
 Version: 1.1.1
 Maintainer: EditorConfig Team <http://editorconfig.org>
 Description: EditorConfig vim plugin
 
-License:
-   Copyright (c) 2011-2019 EditorConfig Team
-   All rights reserved.
-
-   Redistribution and use in source and binary forms, with or without
-   modification, are permitted provided that the following conditions are met:
-
-   1. Redistributions of source code must retain the above copyright notice,
-      this list of conditions and the following disclaimer.
-   2. Redistributions in binary form must reproduce the above copyright notice,
-      this list of conditions and the following disclaimer in the documentation
-      and/or other materials provided with the distribution.
-
-   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-   ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
-   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-   POSSIBILITY OF SUCH DAMAGE.
-
-
 CONTENTS~
                                             *editorconfig-contents*
 ----------------------------------------------------------------------------
@@ -39,6 +13,7 @@ 2.  Installation                        
 3.  Commands                                 |editorconfig-commands|
 4.  Settings                                 |editorconfig-settings|
 5.  Advanced                                 |editorconfig-advanced|
+6.  License                                  |editorconfig-license|
 
 
 OVERVIEW~
@@ -230,4 +205,34 @@ And add the following code to your .edit
 Then try to open an Objective-C file, you will find the |filetype| is set to
 "objc".
 
-vim:ft=help:tw=78
+License~
+                                               *editorconfig-license*
+----------------------------------------------------------------------------
+
+License:
+   Copyright (c) 2011-2019 EditorConfig Team
+   All rights reserved.
+
+   Redistribution and use in source and binary forms, with or without
+   modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+   2. Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+
+   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+   ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+   POSSIBILITY OF SUCH DAMAGE.
+
+
+vim:ft=help:tw=78:cc=
--- a/runtime/pack/dist/opt/editorconfig/doc/tags
+++ b/runtime/pack/dist/opt/editorconfig/doc/tags
@@ -6,6 +6,7 @@ editorconfig-commands	editorconfig.txt	/
 editorconfig-contents	editorconfig.txt	/*editorconfig-contents*
 editorconfig-hook	editorconfig.txt	/*editorconfig-hook*
 editorconfig-installation	editorconfig.txt	/*editorconfig-installation*
+editorconfig-license	editorconfig.txt	/*editorconfig-license*
 editorconfig-overview	editorconfig.txt	/*editorconfig-overview*
 editorconfig-settings	editorconfig.txt	/*editorconfig-settings*
 editorconfig.txt	editorconfig.txt	/*editorconfig.txt*