summary refs log tree commit diff
path: root/doc/languages-frameworks/vim.section.md
diff options
context:
space:
mode:
authorryneeverett <ryneeverett@gmail.com>2020-03-31 01:01:33 +0000
committerryneeverett <ryneeverett@gmail.com>2020-04-01 17:19:01 +0000
commit0a2759483a69d49a0580d3e9e994029f1d8f5bf0 (patch)
tree9fc33d45dd3d32f27ef0ed7e0fae24766d11de5c /doc/languages-frameworks/vim.section.md
parent1c0f0de46c231d6c392b9727327d9635fc4f60ec (diff)
downloadnixpkgs-0a2759483a69d49a0580d3e9e994029f1d8f5bf0.tar
nixpkgs-0a2759483a69d49a0580d3e9e994029f1d8f5bf0.tar.gz
nixpkgs-0a2759483a69d49a0580d3e9e994029f1d8f5bf0.tar.bz2
nixpkgs-0a2759483a69d49a0580d3e9e994029f1d8f5bf0.tar.lz
nixpkgs-0a2759483a69d49a0580d3e9e994029f1d8f5bf0.tar.xz
nixpkgs-0a2759483a69d49a0580d3e9e994029f1d8f5bf0.tar.zst
nixpkgs-0a2759483a69d49a0580d3e9e994029f1d8f5bf0.zip
vimPlugins: update auto-commiting based on review
- Use git.Repo(ROOT, search_parent_directories=True) to find nixpkgs
repo.
- Don't commit overrides.nix.
- Remove "-a" short argument.
- Remove "--commit" flag and commit by default.
- Improve help/error messages.
- Favor closure pattern over classes.Use a closure to wrap the update
function with state rather than a callable class.
- break NixpkgsRepo class into functions
- Optional None-type arguments
- Remove repo checks from update.py. Git is too flexible and permits too
many workflows for my attempt to replace documentation with code to work.
My goal would be to separate the `--add` functionality from the update
functionality in the near term and then there will be no reason for this
usage to create commits anyway.
Diffstat (limited to 'doc/languages-frameworks/vim.section.md')
-rw-r--r--doc/languages-frameworks/vim.section.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/languages-frameworks/vim.section.md b/doc/languages-frameworks/vim.section.md
index 1d316cf350e..4911509212e 100644
--- a/doc/languages-frameworks/vim.section.md
+++ b/doc/languages-frameworks/vim.section.md
@@ -261,7 +261,7 @@ deoplete-fish = super.deoplete-fish.overrideAttrs(old: {
 
 Sometimes plugins require an override that must be changed when the plugin is updated. This can cause issues when Vim plugins are auto-updated but the associated override isn't updated. For these plugins, the override should be written so that it specifies all information required to install the plugin, and running `./update.py` doesn't change the derivation for the plugin. Manually updating the override is required to update these types of plugins. An example of such a plugin is `LanguageClient-neovim`.
 
-To add a new plugin, run `./update.py --commit --add "[owner]/[name]"`.
+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.
 
 ## Important repositories