doc(vim): take into account plug non-support

Apply suggestions from code review

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
This commit is contained in:
Matthieu Coudron
2022-09-02 00:53:55 +02:00
parent 3944240476
commit 800323c0c0
3 changed files with 16 additions and 5 deletions

View File

@@ -8,7 +8,7 @@ Loading can be deferred; see examples.
At the moment we support two different methods for managing plugins: At the moment we support two different methods for managing plugins:
- Vim packages (*recommended*) - Vim packages (*recommended*)
- vim-plug - vim-plug (vim only)
## Custom configuration {#custom-configuration} ## Custom configuration {#custom-configuration}
@@ -196,7 +196,7 @@ vim_configurable.customize {
} }
``` ```
Note: this is not possible anymore for neovim. Note: this is not possible anymore for Neovim.
## Adding new plugins to nixpkgs {#adding-new-plugins-to-nixpkgs} ## Adding new plugins to nixpkgs {#adding-new-plugins-to-nixpkgs}
@@ -215,7 +215,7 @@ Sometimes plugins require an override that must be changed when the plugin is up
To add a new plugin, run `./update.py --add "[owner]/[name]"`. **NOTE**: This script automatically commits to your git repository. Be sure to check out a fresh branch before running. To add a new plugin, run `./update.py --add "[owner]/[name]"`. **NOTE**: This script automatically commits to your git repository. Be sure to check out a fresh branch before running.
Finally, there are some plugins that are also packaged in nodePackages because they have Javascript-related build steps, such as running webpack. Those plugins are not listed in `vim-plugin-names` or managed by `update.py` at all, and are included separately in `overrides.nix`. Currently, all these plugins are related to the `coc.nvim` ecosystem of the Language Server Protocol integration with vim/neovim. Finally, there are some plugins that are also packaged in nodePackages because they have Javascript-related build steps, such as running webpack. Those plugins are not listed in `vim-plugin-names` or managed by `update.py` at all, and are included separately in `overrides.nix`. Currently, all these plugins are related to the `coc.nvim` ecosystem of the Language Server Protocol integration with Vim/Neovim.
## Updating plugins in nixpkgs {#updating-plugins-in-nixpkgs} ## Updating plugins in nixpkgs {#updating-plugins-in-nixpkgs}
@@ -235,16 +235,20 @@ Alternatively, set the number of processes to a lower count to avoid rate-limiti
You can use the updater script to generate basic packages out of a custom vim You can use the updater script to generate basic packages out of a custom vim
plugin list: plugin list:
``` ```
pkgs/applications/editors/vim/plugins/update.py -i vim-plugin-names -o generated.nix --no-commit pkgs/applications/editors/vim/plugins/update.py -i vim-plugin-names -o generated.nix --no-commit
``` ```
with the contents of "vim-plugin-names" being for example:
with the contents of `vim-plugin-names` being for example:
``` ```
repo,branch,alias repo,branch,alias
pwntester/octo.nvim,, pwntester/octo.nvim,,
``` ```
You can then reference the generated vim plugins via: You can then reference the generated vim plugins via:
```nix ```nix
myVimPlugins = pkgs.vimPlugins.extend ( myVimPlugins = pkgs.vimPlugins.extend (
(pkgs.callPackage generated.nix {}) (pkgs.callPackage generated.nix {})

View File

@@ -487,6 +487,12 @@
instead. instead.
</para> </para>
</listitem> </listitem>
<listitem>
<para>
Neovim can not be configured with plug anymore (still works
for vim).
</para>
</listitem>
<listitem> <listitem>
<para> <para>
<literal>k3s</literal> no longer supports docker as runtime <literal>k3s</literal> no longer supports docker as runtime

View File

@@ -168,7 +168,8 @@ Available as [services.patroni](options.html#opt-services.patroni.enable).
- The `paperless` module now defaults `PAPERLESS_TIME_ZONE` to your configured system timezone. - The `paperless` module now defaults `PAPERLESS_TIME_ZONE` to your configured system timezone.
- (Neo)Vim can not be configured with `configure.pathogen` anymore to reduce maintainance burden. - (Neo)Vim can not be configured with `configure.pathogen` anymore to reduce maintainance burden.
Use `configure.packages` instead. Use `configure.packages` instead.
- Neovim can not be configured with plug anymore (still works for vim).
- `k3s` no longer supports docker as runtime due to upstream dropping support. - `k3s` no longer supports docker as runtime due to upstream dropping support.