summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorVladimír Čunát <v@cunat.cz>2020-10-31 14:30:44 +0100
committerVladimír Čunát <v@cunat.cz>2020-10-31 14:30:44 +0100
commitdfd3ede68d58e3f992a0e3befbc820bd931c3437 (patch)
tree971ae40cf6b50b92a3fef8580c703d9d87b3d088 /doc
parent9c5154b5aaee073eeca7f94359d69c93d4dbf5b3 (diff)
parent680d3201230c7864755bff80fcdef30d7487500a (diff)
Merge branch 'master' into staging-next
Diffstat (limited to 'doc')
-rw-r--r--doc/contributing/coding-conventions.xml10
-rw-r--r--doc/languages-frameworks/vim.section.md14
2 files changed, 24 insertions, 0 deletions
diff --git a/doc/contributing/coding-conventions.xml b/doc/contributing/coding-conventions.xml
index fcb6501f6159..e587275a6383 100644
--- a/doc/contributing/coding-conventions.xml
+++ b/doc/contributing/coding-conventions.xml
@@ -524,6 +524,16 @@ args.stdenv.mkDerivation (args // {
</varlistentry>
<varlistentry>
<term>
+ If it’s a <emphasis>terminal emulator</emphasis>:
+ </term>
+ <listitem>
+ <para>
+ <filename>applications/terminal-emulators</filename> (e.g. <filename>alacritty</filename> or <filename>rxvt</filename> or <filename>termite</filename>)
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
If it’s for <emphasis>video playback / editing</emphasis>:
</term>
<listitem>
diff --git a/doc/languages-frameworks/vim.section.md b/doc/languages-frameworks/vim.section.md
index 8e4826232e1a..84ad567e8c21 100644
--- a/doc/languages-frameworks/vim.section.md
+++ b/doc/languages-frameworks/vim.section.md
@@ -265,6 +265,20 @@ To add a new plugin, run `./update.py --add "[owner]/[name]"`. **NOTE**: This sc
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 Language Server Protocol integration with vim/neovim.
+## Updating plugins in nixpkgs
+
+Run the update script with a GitHub API token that has at least `public_repo` access. Running the script without the token is likely to result in rate-limiting (429 errors). For steps on creating an API token, please refer to [GitHub's token documentation](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token).
+
+```sh
+GITHUB_API_TOKEN=my_token ./pkgs/misc/vim-plugins/update.py
+```
+
+Alternatively, set the number of processes to a lower count to avoid rate-limiting.
+
+```sh
+./pkgs/misc/vim-plugins/update.py --proc 1
+```
+
## Important repositories
- [vim-pi](https://bitbucket.org/vimcommunity/vim-pi) is a plugin repository