summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThe Bundler Bot <bot@bundler.io>2017-07-25 00:58:13 +0000
committerThe Bundler Bot <bot@bundler.io>2017-07-25 00:58:13 +0000
commitc34f20a39b03d07f72089fa58bf5af24edd6b490 (patch)
treede6724afe9bb090e76198e790ed356e0357b3c77
parent2cfb720d5ef0666454e7441df5b40c32b3620dc5 (diff)
parent19c014d44516da7f8cd0cb60acad2def8671859f (diff)
downloadbundler-c34f20a39b03d07f72089fa58bf5af24edd6b490.tar.gz
Auto merge of #5891 - arbonap:master, r=segiddins
Alphabetize install flags; add links to Rubygems docs Thanks so much for the contribution! To make reviewing this PR a bit easier, please fill out answers to the following questions. ### What was the end-user problem that led to this PR? The problem was... - I noticed the flag options for the `bundle install` docs weren't alphabetized. - Also, at the end of the `bundle install` page, I created links to the RubyGems docs regarding the `gem install` command. ### What was your diagnosis of the problem? My diagnosis was... - I asked around and found out the flags weren't ordered by importance or anything like that, so I decided to alphabetize them. ### What is your fix for the problem, implemented in this PR? My fix... - I alphabetized the flags on the `bundle install` page ✨ ### Why did you choose this fix out of the possible options? I chose this fix because... - Hopefully this can help users more quickly find the `bundle install` flag they want to read up on. 🙌🏽
-rw-r--r--man/bundle-install.ronn60
1 files changed, 30 insertions, 30 deletions
diff --git a/man/bundle-install.ronn b/man/bundle-install.ronn
index d4bc34909a..0390d4b6a9 100644
--- a/man/bundle-install.ronn
+++ b/man/bundle-install.ronn
@@ -5,24 +5,24 @@ bundle-install(1) -- Install the dependencies specified in your Gemfile
`bundle install` [--binstubs[=DIRECTORY]]
[--clean]
+ [--deployment]
+ [--force]
+ [--frozen]
[--full-index]
[--gemfile=GEMFILE]
[--jobs=NUMBER]
[--local]
- [--deployment]
- [--force]
- [--frozen]
[--no-cache]
[--no-prune]
[--path PATH]
- [--system]
[--quiet]
[--retry=NUMBER]
[--shebang]
[--standalone[=GROUP[ GROUP...]]]
+ [--system]
[--trust-policy=POLICY]
- [--without=GROUP[ GROUP...]]
[--with=GROUP[ GROUP...]]
+ [--without=GROUP[ GROUP...]]
## DESCRIPTION
@@ -43,7 +43,7 @@ update process below under [CONSERVATIVE UPDATING][].
## OPTIONS
-To apply any of `--deployment`, `--path`, `--binstubs`, or `--without` every
+To apply any of `--binstubs`, `--deployment`, `--path`, or `--without` every
time `bundle install` is run, use `bundle config` (see bundle-config(1)).
* `--binstubs[=<directory>]`:
@@ -59,6 +59,19 @@ time `bundle install` is run, use `bundle config` (see bundle-config(1)).
in the current Gemfile(5). Don't worry, gems currently in use will not be
removed.
+* `--deployment`:
+ In [deployment mode][DEPLOYMENT MODE], Bundler will 'roll-out' the bundle for
+ production or CI use. Please check carefully if you want to have this option
+ enabled in your development environment.
+
+* `--force`:
+ Force download every gem, even if the required versions are already available
+ locally.
+
+* `--frozen`:
+ Do not allow the Gemfile.lock to be updated after this install. Exits
+ non-zero if there are going to be changes to the Gemfile.lock.
+
* `--full-index`:
Bundler will not call Rubygems' API endpoint (default) but download and cache
a (currently big) index file of all gems. Performance can be improved for
@@ -81,23 +94,6 @@ time `bundle install` is run, use `bundle config` (see bundle-config(1)).
appropriate platform-specific gem exists on `rubygems.org` it will not be
found.
-* `--deployment`:
- In [deployment mode][DEPLOYMENT MODE], Bundler will 'roll-out' the bundle for
- production or CI use. Please check carefully if you want to have this option
- enabled in your development environment.
-
-* `--force`:
- Force download every gem, even if the required versions are already available
- locally.
-
-* `--frozen`:
- Do not allow the Gemfile.lock to be updated after this install. Exits
- non-zero if there are going to be changes to the Gemfile.lock.
-
-* `--system`:
- Installs the gems specified in the bundle to the system's Rubygems location.
- This overrides any previous configuration of `--path`.
-
* `--no-cache`:
Do not update the cache in `vendor/cache` with the newly bundled gems. This
does not remove any gems in the cache but keeps the newly bundled gems from
@@ -134,23 +130,27 @@ time `bundle install` is run, use `bundle config` (see bundle-config(1)).
in the manner required. Using this option implicitly sets `path`, which is a
[remembered option][REMEMBERED OPTIONS].
+* `--system`:
+ Installs the gems specified in the bundle to the system's Rubygems location.
+ This overrides any previous configuration of `--path`.
+
* `--trust-policy=[<policy>]`:
Apply the Rubygems security policy <policy>, where policy is one of
`HighSecurity`, `MediumSecurity`, `LowSecurity`, `AlmostNoSecurity`, or
`NoSecurity`. For more details, please see the Rubygems signing documentation
linked below in [SEE ALSO][].
-* `--without=<list>`:
- A space-separated list of groups referencing gems to skip during installation.
- If a group is given that is in the remembered list of groups given
- to --with, it is removed from that list.
-
* `--with=<list>`:
A space-separated list of groups referencing gems to install. If an
optional group is given it is installed. If a group is given that is
in the remembered list of groups given to --without, it is removed
from that list.
+* `--without=<list>`:
+ A space-separated list of groups referencing gems to skip during installation.
+ If a group is given that is in the remembered list of groups given
+ to --with, it is removed from that list.
+
## DEPLOYMENT MODE
Bundler's defaults are optimized for development. To switch to
@@ -365,5 +365,5 @@ does not work, run [bundle update(1)][bundle-update].
## SEE ALSO
-* Gem install docs: http://guides.rubygems.org/rubygems-basics/#installing-gems
-* Rubygems signing docs: http://guides.rubygems.org/security/
+* [Gem install docs](http://guides.rubygems.org/rubygems-basics/#installing-gems)
+* [Rubygems signing docs](http://guides.rubygems.org/security/)