bundler 1.13.6 → 1.17.3

data/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,10 +59,23 @@ 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. `--redownload` is an alias of this option.
+
+* `--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
-  large bundles that seldomly change by enabling this option.
+  large bundles that seldom change by enabling this option.
 
 * `--gemfile=<gemfile>`:
   The location of the Gemfile(5) which Bundler should use. This defaults
@@ -71,7 +84,7 @@ time `bundle install` is run, use `bundle config` (see bundle-config(1)).
   root and will try to find `Gemfile.lock` and `vendor/cache` relative
   to this location.
 
-* `--jobs=[<number>]`:
+* `--jobs=[<number>]`, `-j[<number>]`:
   The maximum number of parallel download and install jobs. The default
   is `1`.
 
@@ -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
@@ -110,7 +106,7 @@ time `bundle install` is run, use `bundle config` (see bundle-config(1)).
   The location to install the specified gems to. This defaults to Rubygems'
   setting. Bundler shares this location with Rubygems, `gem install ...` will
   have gem installed there, too. Therefore, gems installed without a
-  `--path ...` setting will show up by calling `gem list`. Accodingly, gems
+  `--path ...` setting will show up by calling `gem list`. Accordingly, gems
   installed to other locations will not get listed.
 
 * `--quiet`:
@@ -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
@@ -290,12 +290,21 @@ of a dependency of a gem in your Gemfile(5)) can result in radically
 different gems being needed to satisfy all dependencies.
 
 As a result, you `SHOULD` check your `Gemfile.lock` into version
-control. If you do not, every machine that checks out your
-repository (including your production server) will resolve all
+control, in both applications and gems. If you do not, every machine that
+checks out your repository (including your production server) will resolve all
 dependencies again, which will result in different versions of
 third-party code being used if `any` of the gems in the Gemfile(5)
 or any of their dependencies have been updated.
 
+When Bundler first shipped, the `Gemfile.lock` was included in the `.gitignore`
+file included with generated gems.  Over time, however, it became clear that
+this practice forces the pain of broken dependencies onto new contributors,
+while leaving existing contributors potentially unaware of the problem. Since
+`bundle install` is usually the first step towards a contribution, the pain of
+broken dependencies would discourage new contributors from contributing. As a
+result, we have revised our guidance for gem authors to now recommend checking
+in the lock for gems.
+
 ## CONSERVATIVE UPDATING
 
 When you make a change to the Gemfile(5) and then run `bundle install`,
@@ -361,9 +370,9 @@ which other gems in the Gemfile(5) still depend on, run
 `Summary`: In general, after making a change to the Gemfile(5) , you
 should first try to run `bundle install`, which will guarantee that no
 other gem in the Gemfile(5) is impacted by the change. If that
-does not work, run [bundle update(1)][bundle-update].
+does not work, run [bundle update(1)](bundle-update.1.html).
 
 ## 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/)

data/man/bundle-list.1

@@ -0,0 +1,50 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "BUNDLE\-LIST" "1" "December 2018" "" ""
+.
+.SH "NAME"
+\fBbundle\-list\fR \- List all the gems in the bundle
+.
+.SH "SYNOPSIS"
+\fBbundle list\fR [\-\-name\-only] [\-\-paths] [\-\-without\-group=GROUP] [\-\-only\-group=GROUP]
+.
+.SH "DESCRIPTION"
+Prints a list of all the gems in the bundle including their version\.
+.
+.P
+Example:
+.
+.P
+bundle list \-\-name\-only
+.
+.P
+bundle list \-\-paths
+.
+.P
+bundle list \-\-without\-group test
+.
+.P
+bundle list \-\-only\-group dev
+.
+.P
+bundle list \-\-only\-group dev \-\-paths
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-\-name\-only\fR
+Print only the name of each gem\.
+.
+.TP
+\fB\-\-paths\fR
+Print the path to each gem in the bundle\.
+.
+.TP
+\fB\-\-without\-group\fR
+Print all gems expect from a group\.
+.
+.TP
+\fB\-\-only\-group\fR
+Print gems from a particular group\.
+

data/man/bundle-list.1.txt

@@ -0,0 +1,43 @@
+BUNDLE-LIST(1)							BUNDLE-LIST(1)
+
+
+
+NAME
+       bundle-list - List all the gems in the bundle
+
+SYNOPSIS
+       bundle	 list	 [--name-only]	  [--paths]    [--without-group=GROUP]
+       [--only-group=GROUP]
+
+DESCRIPTION
+       Prints a list of all the gems in the bundle including their version.
+
+       Example:
+
+       bundle list --name-only
+
+       bundle list --paths
+
+       bundle list --without-group test
+
+       bundle list --only-group dev
+
+       bundle list --only-group dev --paths
+
+OPTIONS
+       --name-only
+	      Print only the name of each gem.
+
+       --paths
+	      Print the path to each gem in the bundle.
+
+       --without-group
+	      Print all gems expect from a group.
+
+       --only-group
+	      Print gems from a particular group.
+
+
+
+
+				 December 2018			BUNDLE-LIST(1)

data/man/bundle-list.ronn

@@ -0,0 +1,33 @@
+bundle-list(1) -- List all the gems in the bundle
+=========================================================================
+
+## SYNOPSIS
+
+`bundle list` [--name-only] [--paths] [--without-group=GROUP] [--only-group=GROUP]
+
+## DESCRIPTION
+
+Prints a list of all the gems in the bundle including their version.
+
+Example:
+
+bundle list --name-only
+
+bundle list --paths
+
+bundle list --without-group test
+
+bundle list --only-group dev
+
+bundle list --only-group dev --paths
+
+## OPTIONS
+
+* `--name-only`:
+  Print only the name of each gem.
+* `--paths`:
+  Print the path to each gem in the bundle.
+* `--without-group`:
+  Print all gems expect from a group.
+* `--only-group`:
+  Print gems from a particular group.

data/{lib/bundler/man/bundle-lock → man/bundle-lock.1}

@@ -1,13 +1,13 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "BUNDLE\-LOCK" "1" "June 2016" "" ""
+.TH "BUNDLE\-LOCK" "1" "November 2018" "" ""
 .
 .SH "NAME"
 \fBbundle\-lock\fR \- Creates / Updates a lockfile without installing
 .
 .SH "SYNOPSIS"
-\fBbundle lock\fR [\-\-update] [\-\-local] [\-\-print] [\-\-lockfile=PATH]
+\fBbundle lock\fR [\-\-update] [\-\-local] [\-\-print] [\-\-lockfile=PATH] [\-\-full\-index] [\-\-add\-platform] [\-\-remove\-platform] [\-\-patch] [\-\-minor] [\-\-major] [\-\-strict] [\-\-conservative]
 .
 .SH "DESCRIPTION"
 Lock the gems specified in Gemfile\.
@@ -30,6 +30,38 @@ Prints the lockfile to STDOUT instead of writing to the file system\.
 \fB\-\-lockfile=<path>\fR
 The path where the lockfile should be written to\.
 .
+.TP
+\fB\-\-full\-index\fR
+Fall back to using the single\-file index of all gems\.
+.
+.TP
+\fB\-\-add\-platform\fR
+Add a new platform to the lockfile, re\-resolving for the addition of that platform\.
+.
+.TP
+\fB\-\-remove\-platform\fR
+Remove a platform from the lockfile\.
+.
+.TP
+\fB\-\-patch\fR
+If updating, prefer updating only to next patch version\.
+.
+.TP
+\fB\-\-minor\fR
+If updating, prefer updating only to next minor version\.
+.
+.TP
+\fB\-\-major\fR
+If updating, prefer updating to next major version (default)\.
+.
+.TP
+\fB\-\-strict\fR
+If updating, do not allow any gem to be updated past latest \-\-patch | \-\-minor | \-\-major\.
+.
+.TP
+\fB\-\-conservative\fR
+If updating, use bundle install conservative update behavior and do not allow shared dependencies to be updated\.
+.
 .SH "UPDATING ALL GEMS"
 If you run \fBbundle lock\fR with \fB\-\-update\fR option without list of gems, bundler will ignore any previously installed gems and resolve all dependencies again based on the latest versions of all gems available in the sources\.
 .
@@ -41,3 +73,12 @@ For instance, you only want to update \fBnokogiri\fR, run \fBbundle lock \-\-upd
 .
 .P
 Bundler will update \fBnokogiri\fR and any of its dependencies, but leave the rest of the gems that you specified locked to the versions in the \fBGemfile\.lock\fR\.
+.
+.SH "SUPPORTING OTHER PLATFORMS"
+If you want your bundle to support platforms other than the one you\'re running locally, you can run \fBbundle lock \-\-add\-platform PLATFORM\fR to add PLATFORM to the lockfile, force bundler to re\-resolve and consider the new platform when picking gems, all without needing to have a machine that matches PLATFORM handy to install those platform\-specific gems on\.
+.
+.P
+For a full explanation of gem platforms, see \fBgem help platform\fR\.
+.
+.SH "PATCH LEVEL OPTIONS"
+See bundle update(1) \fIbundle\-update\.1\.html\fR for details\.

data/man/bundle-lock.1.txt

@@ -0,0 +1,93 @@
+BUNDLE-LOCK(1)							BUNDLE-LOCK(1)
+
+
+
+NAME
+       bundle-lock - Creates / Updates a lockfile without installing
+
+SYNOPSIS
+       bundle	 lock	[--update]   [--local]	 [--print]   [--lockfile=PATH]
+       [--full-index] [--add-platform] [--remove-platform] [--patch] [--minor]
+       [--major] [--strict] [--conservative]
+
+DESCRIPTION
+       Lock the gems specified in Gemfile.
+
+OPTIONS
+       --update=<*gems>
+	      Ignores  the  existing  lockfile. Resolve then updates lockfile.
+	      Taking a list of gems or updating all gems if no list is	given.
+
+       --local
+	      Do not attempt to connect to rubygems.org. Instead, Bundler will
+	      use the gems already present  in	Rubygems'  cache  or  in  ven-
+	      dor/cache.  Note	that  if  a  appropriate platform-specific gem
+	      exists on rubygems.org it will not be found.
+
+       --print
+	      Prints the lockfile to STDOUT instead of	writing  to  the  file
+	      system.
+
+       --lockfile=<path>
+	      The path where the lockfile should be written to.
+
+       --full-index
+	      Fall back to using the single-file index of all gems.
+
+       --add-platform
+	      Add  a  new platform to the lockfile, re-resolving for the addi-
+	      tion of that platform.
+
+       --remove-platform
+	      Remove a platform from the lockfile.
+
+       --patch
+	      If updating, prefer updating only to next patch version.
+
+       --minor
+	      If updating, prefer updating only to next minor version.
+
+       --major
+	      If updating, prefer updating to next major version (default).
+
+       --strict
+	      If updating, do not allow any gem  to  be  updated  past	latest
+	      --patch | --minor | --major.
+
+       --conservative
+	      If updating, use bundle install conservative update behavior and
+	      do not allow shared dependencies to be updated.
+
+UPDATING ALL GEMS
+       If you run bundle lock with  --update  option  without  list  of  gems,
+       bundler	will  ignore  any  previously  installed  gems and resolve all
+       dependencies again based on the latest versions of all  gems  available
+       in the sources.
+
+UPDATING A LIST OF GEMS
+       Sometimes, you want to update a single gem in the Gemfile(5), and leave
+       the rest of the gems that you specified locked to the versions  in  the
+       Gemfile.lock.
+
+       For  instance,  you  only  want	to  update  nokogiri,  run bundle lock
+       --update nokogiri.
+
+       Bundler will update nokogiri and any of its dependencies, but leave the
+       rest  of the gems that you specified locked to the versions in the Gem-
+       file.lock.
+
+SUPPORTING OTHER PLATFORMS
+       If you want your bundle to support platforms other than the one	you're
+       running locally, you can run bundle lock --add-platform PLATFORM to add
+       PLATFORM to the lockfile, force bundler to re-resolve and consider  the
+       new  platform  when picking gems, all without needing to have a machine
+       that matches PLATFORM handy to install those platform-specific gems on.
+
+       For a full explanation of gem platforms, see gem help platform.
+
+PATCH LEVEL OPTIONS
+       See bundle update(1) bundle-update.1.html for details.
+
+
+
+				 November 2018			BUNDLE-LOCK(1)