about summary refs log tree commit diff
path: root/pkgs/applications/editors/vim
diff options
context:
space:
mode:
authorMatthieu Coudron <mcoudron@hotmail.com>2022-08-01 02:57:03 +0200
committerMatthieu Coudron <mcoudron@hotmail.com>2022-08-09 12:01:33 +0200
commit0fb2e47b7f4ca4cff34739a0d18524eee2514f32 (patch)
tree6d21ef360a641671a84b3075b251a9e7e328036f /pkgs/applications/editors/vim
parent5d38ae801aebda98d1729ff0f16f943a816e99f6 (diff)
downloadnixlib-0fb2e47b7f4ca4cff34739a0d18524eee2514f32.tar
nixlib-0fb2e47b7f4ca4cff34739a0d18524eee2514f32.tar.gz
nixlib-0fb2e47b7f4ca4cff34739a0d18524eee2514f32.tar.bz2
nixlib-0fb2e47b7f4ca4cff34739a0d18524eee2514f32.tar.lz
nixlib-0fb2e47b7f4ca4cff34739a0d18524eee2514f32.tar.xz
nixlib-0fb2e47b7f4ca4cff34739a0d18524eee2514f32.tar.zst
nixlib-0fb2e47b7f4ca4cff34739a0d18524eee2514f32.zip
vimUtils: improve comments
Diffstat (limited to 'pkgs/applications/editors/vim')
-rw-r--r--pkgs/applications/editors/vim/plugins/vim-utils.nix26
1 files changed, 7 insertions, 19 deletions
diff --git a/pkgs/applications/editors/vim/plugins/vim-utils.nix b/pkgs/applications/editors/vim/plugins/vim-utils.nix
index 4d2742b42418..288a9408d2f8 100644
--- a/pkgs/applications/editors/vim/plugins/vim-utils.nix
+++ b/pkgs/applications/editors/vim/plugins/vim-utils.nix
@@ -165,7 +165,11 @@ let
 
   rtpPath = ".";
 
-  # Generates a packpath folder as expected by vim
+  /* Generates a packpath folder as expected by vim
+       Example:
+       packDir (myVimPackage.{ start = [ vimPlugins.vim-fugitive ]; opt = [] })
+       => "/nix/store/xxxxx-pack-dir"
+  */
   packDir = packages:
   let
     linkVimlPlugin = plugin: packageName: dir: ''
@@ -233,7 +237,7 @@ let
   vimrcContent = {
     packages ? null,
     vam ? null,
-    pathogen ? null,
+    pathogen ? null, # deprecated
     plug ? null,
     beforePlugins ? ''
       " configuration generated by NIX
@@ -255,23 +259,7 @@ let
         call plug#end()
       '';
 
-      /*
-       vim-addon-manager = VAM
-
-       * maps names to plugin location
-
-       * manipulates &rtp at startup time
-         or when Vim has been running for a while
-
-       * can activate plugins laziy (eg when loading a specific filetype)
-
-       * knows about vim plugin dependencies (addon-info.json files)
-
-       * still is minimalistic (only loads one file), the "check out" code it also
-         has only gets loaded when a plugin is requested which is not found on disk
-         yet
-
-      */
+     # vim-addon-manager = VAM (deprecated)
       vamImpl =
       let
         knownPlugins = vam.knownPlugins or vimPlugins;