Merge pull request #52767 from timokau/vim-plugin-updates

Fix vim-plugin dependencies

1 files changed, 6 insertions, 1 deletions

diff --git a/doc/languages-frameworks/vim.section.md b/doc/languages-frameworks/vim.section.md
index 2cec1543a249b..6ed60028ae206 100644
--- a/doc/languages-frameworks/vim.section.md
+++ b/doc/languages-frameworks/vim.section.md
@@ -48,7 +48,7 @@ neovim.override {
 
 ## Managing plugins with Vim packages
 
-To store you plugins in Vim packages the following example can be used:
+To store you plugins in Vim packages (the native vim plugin manager, see `:help packages`) the following example can be used:
 
 ```
 vim_configurable.customize {
@@ -56,6 +56,8 @@ vim_configurable.customize {
     # loaded on launch
     start = [ youcompleteme fugitive ];
     # manually loadable by calling `:packadd $plugin-name`
+    # however, if a vim plugin has a dependency that is not explicitly listed in
+	# opt that dependency will always be added to start to avoid confusion.
     opt = [ phpCompletion elm-vim ];
     # To automatically load a plugin when opening a filetype, add vimrc lines like:
     # autocmd FileType php :packadd phpCompletion
@@ -63,6 +65,7 @@ vim_configurable.customize {
 }
 ```
 
+`myVimPackage` is an arbitrary name for the generated package. You can choose any name you like.
 For Neovim the syntax is:
 
 ```
@@ -74,6 +77,8 @@ neovim.override {
     packages.myVimPackage = with pkgs.vimPlugins; {
       # see examples below how to use custom packages
       start = [ ];
+      # If a vim plugin has a dependency that is not explicitly listed in
+      # opt that dependency will always be added to start to avoid confusion.
       opt = [ ];
     };
   };