summary refs log tree commit diff
path: root/doc/languages-frameworks
diff options
context:
space:
mode:
authorNaïm Favier <n@monade.li>2022-12-04 11:18:38 +0100
committerNaïm Favier <n@monade.li>2022-12-09 09:55:55 +0100
commit4e5ebcc3ed1de9c5c2001c7d5829f4566e0bde3f (patch)
tree10ff706e19ff94170a66270c87d49e4c4913b865 /doc/languages-frameworks
parent35090c8b8b5c0a1282b2c4eab0659f643025cad3 (diff)
downloadnixpkgs-4e5ebcc3ed1de9c5c2001c7d5829f4566e0bde3f.tar
nixpkgs-4e5ebcc3ed1de9c5c2001c7d5829f4566e0bde3f.tar.gz
nixpkgs-4e5ebcc3ed1de9c5c2001c7d5829f4566e0bde3f.tar.bz2
nixpkgs-4e5ebcc3ed1de9c5c2001c7d5829f4566e0bde3f.tar.lz
nixpkgs-4e5ebcc3ed1de9c5c2001c7d5829f4566e0bde3f.tar.xz
nixpkgs-4e5ebcc3ed1de9c5c2001c7d5829f4566e0bde3f.tar.zst
nixpkgs-4e5ebcc3ed1de9c5c2001c7d5829f4566e0bde3f.zip
vim-full: rename from vim_configurable
Avoids confusion: `vim-full`'s build-time features are configurable, but both
`vim` and `vim-full` are *customizable* (in the sense of user configuration).
Diffstat (limited to 'doc/languages-frameworks')
-rw-r--r--doc/languages-frameworks/vim.section.md17
1 files changed, 13 insertions, 4 deletions
diff --git a/doc/languages-frameworks/vim.section.md b/doc/languages-frameworks/vim.section.md
index 0fdf6eb6a12..3490b257612 100644
--- a/doc/languages-frameworks/vim.section.md
+++ b/doc/languages-frameworks/vim.section.md
@@ -10,12 +10,21 @@ At the moment we support two different methods for managing plugins:
 - Vim packages (*recommended*)
 - vim-plug (vim only)
 
+Right now two Vim packages are available: `vim` which has most features that require extra
+dependencies disabled and `vim-full` which has them configurable and enabled by default.
+
+::: {.note}
+`vim_configurable` is a deprecated alias for `vim-full` and refers to the fact that its
+build-time features are configurable. It has nothing to do with user configuration,
+and both the `vim` and `vim-full` packages can be customized as explained in the next section.
+:::
+
 ## Custom configuration {#custom-configuration}
 
 Adding custom .vimrc lines can be done using the following code:
 
 ```nix
-vim_configurable.customize {
+vim-full.customize {
   # `name` optionally specifies the name of the executable and package
   name = "vim-with-plugins";
 
@@ -62,7 +71,7 @@ neovim-qt.override {
 To store your plugins in Vim packages (the native Vim plugin manager, see `:help packages`) the following example can be used:
 
 ```nix
-vim_configurable.customize {
+vim-full.customize {
   vimrcConfig.packages.myVimPackage = with pkgs.vimPlugins; {
     # loaded on launch
     start = [ youcompleteme fugitive ];
@@ -101,7 +110,7 @@ The resulting package can be added to `packageOverrides` in `~/.nixpkgs/config.n
 ```nix
 {
   packageOverrides = pkgs: with pkgs; {
-    myVim = vim_configurable.customize {
+    myVim = vim-full.customize {
       # `name` specifies the name of the executable and package
       name = "vim-with-plugins";
       # add here code from the example section
@@ -190,7 +199,7 @@ To use [vim-plug](https://github.com/junegunn/vim-plug) to manage your Vim
 plugins the following example can be used:
 
 ```nix
-vim_configurable.customize {
+vim-full.customize {
   vimrcConfig.packages.myVimPackage = with pkgs.vimPlugins; {
     # loaded on launch
     plug.plugins = [ youcompleteme fugitive phpCompletion elm-vim ];