summary refs log tree commit diff
path: root/doc/languages-frameworks/vim.section.md
diff options
context:
space:
mode:
authorJörg Thalheim <joerg@thalheim.io>2018-09-09 09:46:35 +0100
committerJörg Thalheim <joerg@thalheim.io>2018-09-09 11:22:43 +0100
commit953199fd829f0b9d3c3ed95cf2e1b138d2268a3b (patch)
treef08dd2d97d9703c3ec96bfab90b195d7103914ca /doc/languages-frameworks/vim.section.md
parent97acac9a81cb16992c8f6ff856ffcbeede667eeb (diff)
downloadnixpkgs-953199fd829f0b9d3c3ed95cf2e1b138d2268a3b.tar
nixpkgs-953199fd829f0b9d3c3ed95cf2e1b138d2268a3b.tar.gz
nixpkgs-953199fd829f0b9d3c3ed95cf2e1b138d2268a3b.tar.bz2
nixpkgs-953199fd829f0b9d3c3ed95cf2e1b138d2268a3b.tar.lz
nixpkgs-953199fd829f0b9d3c3ed95cf2e1b138d2268a3b.tar.xz
nixpkgs-953199fd829f0b9d3c3ed95cf2e1b138d2268a3b.tar.zst
nixpkgs-953199fd829f0b9d3c3ed95cf2e1b138d2268a3b.zip
vim-plugins: rewrite updater
A new python script has been added to replace the aged viml-based
updater. The new updater has the following advantages:

- use rss feeds to check for updates quicker
- parallel downloads & better caching
- uses proper override mechanism instead of text substitution
- update generated files in-place instead of having to insert updated plugins manually

Automatically reading `dependencies` from the plugins directory has been
not re-implemented.
This has been mostly been used by Mark Weber's plugins, which seem to
no longer receive regular updates.
This could be implemented in future as required.
Diffstat (limited to 'doc/languages-frameworks/vim.section.md')
-rw-r--r--doc/languages-frameworks/vim.section.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/languages-frameworks/vim.section.md b/doc/languages-frameworks/vim.section.md
index 26aa9c25f06..f0a6559c3d5 100644
--- a/doc/languages-frameworks/vim.section.md
+++ b/doc/languages-frameworks/vim.section.md
@@ -179,6 +179,18 @@ Sample output2:
     ]
 
 
+## Adding new plugins to nixpkgs
+
+In `pkgs/misc/vim-plugins/vim-plugin-names` we store the plugin names
+for all vim plugins we automatically generate plugins for.
+The format of this file `github username/github repository`:
+For example https://github.com/scrooloose/nerdtree becomes `scrooloose/nerdtree`.
+After adding your plugin to this file run the `./update.py` in the same folder.
+This will updated a file called `generated.nix` and make your plugin accessible in the
+`vimPlugins` attribute set (`vimPlugins.nerdtree` in our example).
+If additional steps to the build process of the plugin are required, add an
+override to the `pkgs/misc/vim-plugins/default.nix` in the same directory.
+
 ## Important repositories
 
 - [vim-pi](https://bitbucket.org/vimcommunity/vim-pi) is a plugin repository