summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorAgrim Mittal <agrimmittal97@gmail.com>2018-07-01 11:55:40 +0530
committerAgrim Mittal <agrimmittal97@gmail.com>2018-07-01 11:55:40 +0530
commitabaa283466376d858436147495f011a331393d8d (patch)
tree8a256c11d5798e058478761e26712e9d046dc619 /man
parentdf258d9f5098d4ed103adcff2eb01afacfa2abe7 (diff)
downloadbundler-abaa283466376d858436147495f011a331393d8d.tar.gz
Update documentation
Diffstat (limited to 'man')
-rw-r--r--man/bundle-remove.ronn10
1 files changed, 4 insertions, 6 deletions
diff --git a/man/bundle-remove.ronn b/man/bundle-remove.ronn
index f1ad41938e..40a239b4a2 100644
--- a/man/bundle-remove.ronn
+++ b/man/bundle-remove.ronn
@@ -1,20 +1,18 @@
-bundle-remove(1) -- Removes gem specified in Gemfile
+bundle-remove(1) -- Removes gems from the Gemfile
===========================================================================
## SYNOPSIS
-`bundle remove [GEMS] [--install]`
+`bundle remove [GEM [GEM ...]] [--install]`
## DESCRIPTION
-Removes a set of specified gems from the Gemfile or if needed runs `bundle install` and removes them from bundle as well.
-If any gem specified to be removed does not exist the in Gemfile, Bundler prints error message.
-If the gem could not be removed due to any reason, Bundler warns the user.
+Removes the given gems from the Gemfile while ensuring that the resulting Gemfile is still valid. If a gem cannot be removed, a warning is printed. If a gem is already absent from the Gemfile, and error is raised.
## OPTIONS
* `--install`:
- Runs 'bundle install' after removing the gems from the gemfile. This option sync the lockfile.
+ Runs `bundle install` after the given gems have been removed from the Gemfile, which ensures that both the lockfile and the installed gems on disk are also updated to remove the given gem(s).
Example: