From c90051c53db56a3717cd4bab0ad4e1010ebfd3da Mon Sep 17 00:00:00 2001 From: Trolli Schmittlauch Date: Wed, 24 Oct 2018 17:02:54 +0200 Subject: [PATCH] clarifying `name` arg determines vim command name The `name` arg of `vim_configurable.customize` does not only determine the package name, but also the name of the command/ executable to be called. In my opinion this is not documented properly and finding that out took me several hours. --- doc/languages-frameworks/vim.section.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/languages-frameworks/vim.section.md b/doc/languages-frameworks/vim.section.md index 1b235dbb52f6..2cec1543a249 100644 --- a/doc/languages-frameworks/vim.section.md +++ b/doc/languages-frameworks/vim.section.md @@ -23,6 +23,7 @@ Adding custom .vimrc lines can be done using the following code: ``` vim_configurable.customize { + # `name` specifies the name of the executable and package name = "vim-with-plugins"; vimrcConfig.customRC = '' @@ -31,6 +32,8 @@ vim_configurable.customize { } ``` +This configuration is used when vim is invoked with the command specified as name, in this case `vim-with-plugins`. + For Neovim the `configure` argument can be overridden to achieve the same: ``` @@ -83,6 +86,7 @@ The resulting package can be added to `packageOverrides` in `~/.nixpkgs/config.n { packageOverrides = pkgs: with pkgs; { myVim = vim_configurable.customize { + # `name` specifies the name of the executable and package name = "vim-with-plugins"; # add here code from the example section };