bundler 1.9.0 → 1.17.3

data/man/bundle-package.1.txt

@@ -0,0 +1,79 @@
+BUNDLE-PACKAGE(1)					     BUNDLE-PACKAGE(1)
+
+
+
+NAME
+       bundle-package - Package your needed .gem files into your application
+
+SYNOPSIS
+       bundle package
+
+DESCRIPTION
+       Copy  all of the .gem files needed to run the application into the ven-
+       dor/cache   directory.	In   the   future,   when   running    [bundle
+       install(1)][bundle-install], use the gems in the cache in preference to
+       the ones on rubygems.org.
+
+GIT AND PATH GEMS
+       Since Bundler 1.2, the bundle package command can also package :git and
+       :path  dependencies  besides  .gem  files.  This needs to be explicitly
+       enabled via the --all option. Once  used,  the  --all  option  will  be
+       remembered.
+
+SUPPORT FOR MULTIPLE PLATFORMS
+       When  using  gems that have different packages for different platforms,
+       Bundler 1.8 and newer support caching of gems for other platforms where
+       the  Gemfile  has  been resolved (i.e. present in the lockfile) in ven-
+       dor/cache. This needs to be enabled  via  the  --all-platforms  option.
+       This setting will be remembered in your local bundler configuration.
+
+REMOTE FETCHING
+       By  default, if you run bundle install(1)](bundle-install.1.html) after
+       running bundle package(1)  bundle-package.1.html,  bundler  will  still
+       connect to rubygems.org to check whether a platform-specific gem exists
+       for any of the gems in vendor/cache.
+
+       For instance, consider this Gemfile(5):
+
+
+
+	   source "https://rubygems.org"
+
+	   gem "nokogiri"
+
+
+
+       If you run bundle package under C Ruby, bundler will retrieve the  ver-
+       sion  of  nokogiri  for the "ruby" platform. If you deploy to JRuby and
+       run bundle install, bundler is forced to check to see whether a	"java"
+       platformed nokogiri exists.
+
+       Even  though  the  nokogiri  gem  for  the Ruby platform is technically
+       acceptable on JRuby, it has a C extension that does not run  on	JRuby.
+       As a result, bundler will, by default, still connect to rubygems.org to
+       check whether it has a version of one of your  gems  more  specific  to
+       your platform.
+
+       This  problem  is  also	not  limited to the "java" platform. A similar
+       (common) problem can happen when developing on Windows and deploying to
+       Linux, or even when developing on OSX and deploying to Linux.
+
+       If  you know for sure that the gems packaged in vendor/cache are appro-
+       priate for the platform you are on, you can run bundle install  --local
+       to  skip  checking  for more appropriate gems, and use the ones in ven-
+       dor/cache.
+
+       One way to be sure that you have the right platformed versions  of  all
+       your gems is to run bundle package on an identical machine and check in
+       the gems. For instance, you can run  bundle  package  on  an  identical
+       staging	box during your staging process, and check in the vendor/cache
+       before deploying to production.
+
+       By default, bundle package(1) bundle-package.1.html  fetches  and  also
+       installs  the gems to the default location. To package the dependencies
+       to vendor/cache without installing them to the local install  location,
+       you can run bundle package --no-install.
+
+
+
+				 November 2018		     BUNDLE-PACKAGE(1)

data/man/bundle-package.ronn

@@ -20,14 +20,15 @@ via the `--all` option. Once used, the `--all` option will be remembered.
 ## SUPPORT FOR MULTIPLE PLATFORMS
 
 When using gems that have different packages for different platforms, Bundler
-1.8 and newer support caching of gems for other platforms in `vendor/cache`.
-This needs to be enabled via the `--all-platforms` option. This setting will be
-remembered in your local bundler configuration.
+1.8 and newer support caching of gems for other platforms where the Gemfile
+has been resolved (i.e. present in the lockfile) in `vendor/cache`.  This needs
+to be enabled via the `--all-platforms` option. This setting will be remembered
+in your local bundler configuration.
 
 ## REMOTE FETCHING
 
-By default, if you simply run [bundle install(1)][bundle-install] after running
-[bundle package(1)][bundle-package], bundler will still connect to `rubygems.org`
+By default, if you run `bundle install(1)`](bundle-install.1.html) after running
+[bundle package(1)](bundle-package.1.html), bundler will still connect to `rubygems.org`
 to check whether a platform-specific gem exists for any of the gems
 in `vendor/cache`.
 
@@ -43,12 +44,12 @@ to JRuby and run `bundle install`, bundler is forced to check to
 see whether a `"java"` platformed `nokogiri` exists.
 
 Even though the `nokogiri` gem for the Ruby platform is
-_technically_ acceptable on JRuby, it actually has a C extension
+_technically_ acceptable on JRuby, it has a C extension
 that does not run on JRuby. As a result, bundler will, by default,
 still connect to `rubygems.org` to check whether it has a version
 of one of your gems more specific to your platform.
 
-This problem is also not just limited to the `"java"` platform.
+This problem is also not limited to the `"java"` platform.
 A similar (common) problem can happen when developing on Windows
 and deploying to Linux, or even when developing on OSX and
 deploying to Linux.
@@ -56,7 +57,7 @@ deploying to Linux.
 If you know for sure that the gems packaged in `vendor/cache`
 are appropriate for the platform you are on, you can run
 `bundle install --local` to skip checking for more appropriate
-gems, and just use the ones in `vendor/cache`.
+gems, and use the ones in `vendor/cache`.
 
 One way to be sure that you have the right platformed versions
 of all your gems is to run `bundle package` on an identical
@@ -64,3 +65,8 @@ machine and check in the gems. For instance, you can run
 `bundle package` on an identical staging box during your
 staging process, and check in the `vendor/cache` before
 deploying to production.
+
+By default, [bundle package(1)](bundle-package.1.html) fetches and also
+installs the gems to the default location. To package the
+dependencies to `vendor/cache` without installing them to the
+local install location, you can run `bundle package --no-install`.

data/man/bundle-platform.1

@@ -0,0 +1,61 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "BUNDLE\-PLATFORM" "1" "November 2018" "" ""
+.
+.SH "NAME"
+\fBbundle\-platform\fR \- Displays platform compatibility information
+.
+.SH "SYNOPSIS"
+\fBbundle platform\fR [\-\-ruby]
+.
+.SH "DESCRIPTION"
+\fBplatform\fR will display information from your Gemfile, Gemfile\.lock, and Ruby VM about your platform\.
+.
+.P
+For instance, using this Gemfile(5):
+.
+.IP "" 4
+.
+.nf
+
+source "https://rubygems\.org"
+
+ruby "1\.9\.3"
+
+gem "rack"
+.
+.fi
+.
+.IP "" 0
+.
+.P
+If you run \fBbundle platform\fR on Ruby 1\.9\.3, it will display the following output:
+.
+.IP "" 4
+.
+.nf
+
+Your platform is: x86_64\-linux
+
+Your app has gems that work on these platforms:
+* ruby
+
+Your Gemfile specifies a Ruby version requirement:
+* ruby 1\.9\.3
+
+Your current platform satisfies the Ruby version requirement\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fBplatform\fR will list all the platforms in your \fBGemfile\.lock\fR as well as the \fBruby\fR directive if applicable from your Gemfile(5)\. It will also let you know if the \fBruby\fR directive requirement has been met\. If \fBruby\fR directive doesn\'t match the running Ruby VM, it will tell you what part does not\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-\-ruby\fR
+It will display the ruby directive information, so you don\'t have to parse it from the Gemfile(5)\.
+

data/man/bundle-platform.1.txt

@@ -0,0 +1,57 @@
+BUNDLE-PLATFORM(1)					    BUNDLE-PLATFORM(1)
+
+
+
+NAME
+       bundle-platform - Displays platform compatibility information
+
+SYNOPSIS
+       bundle platform [--ruby]
+
+DESCRIPTION
+       platform  will display information from your Gemfile, Gemfile.lock, and
+       Ruby VM about your platform.
+
+       For instance, using this Gemfile(5):
+
+
+
+	   source "https://rubygems.org"
+
+	   ruby "1.9.3"
+
+	   gem "rack"
+
+
+
+       If you run bundle platform on Ruby 1.9.3, it will display the following
+       output:
+
+
+
+	   Your platform is: x86_64-linux
+
+	   Your app has gems that work on these platforms:
+	   * ruby
+
+	   Your Gemfile specifies a Ruby version requirement:
+	   * ruby 1.9.3
+
+	   Your current platform satisfies the Ruby version requirement.
+
+
+
+       platform  will  list  all the platforms in your Gemfile.lock as well as
+       the ruby directive if applicable from your Gemfile(5). It will also let
+       you know if the ruby directive requirement has been met. If ruby direc-
+       tive doesn't match the running Ruby VM, it will tell you what part does
+       not.
+
+OPTIONS
+       --ruby It  will	display  the  ruby directive information, so you don't
+	      have to parse it from the Gemfile(5).
+
+
+
+
+				 November 2018		    BUNDLE-PLATFORM(1)

data/man/bundle-platform.ronn

@@ -38,5 +38,5 @@ match the running Ruby VM, it will tell you what part does not.
 ## OPTIONS
 
 * `--ruby`:
-  It will just display the ruby directive information, so you don't have to
+  It will display the ruby directive information, so you don't have to
   parse it from the Gemfile(5).

data/man/bundle-pristine.1

@@ -0,0 +1,34 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "BUNDLE\-PRISTINE" "1" "November 2018" "" ""
+.
+.SH "NAME"
+\fBbundle\-pristine\fR \- Restores installed gems to their pristine condition
+.
+.SH "SYNOPSIS"
+\fBbundle pristine\fR
+.
+.SH "DESCRIPTION"
+\fBpristine\fR restores the installed gems in the bundle to their pristine condition using the local gem cache from RubyGems\. For git gems, a forced checkout will be performed\.
+.
+.P
+For further explanation, \fBbundle pristine\fR ignores unpacked files on disk\. In other words, this command utilizes the local \fB\.gem\fR cache or the gem\'s git repository as if one were installing from scratch\.
+.
+.P
+Note: the Bundler gem cannot be restored to its original state with \fBpristine\fR\. One also cannot use \fBbundle pristine\fR on gems with a \'path\' option in the Gemfile, because bundler has no original copy it can restore from\.
+.
+.P
+When is it practical to use \fBbundle pristine\fR?
+.
+.P
+It comes in handy when a developer is debugging a gem\. \fBbundle pristine\fR is a great way to get rid of experimental changes to a gem that one may not want\.
+.
+.P
+Why use \fBbundle pristine\fR over \fBgem pristine \-\-all\fR?
+.
+.P
+Both commands are very similar\. For context: \fBbundle pristine\fR, without arguments, cleans all gems from the lockfile\. Meanwhile, \fBgem pristine \-\-all\fR cleans all installed gems for that Ruby version\.
+.
+.P
+If a developer forgets which gems in their project they might have been debugging, the Rubygems \fBgem pristine [GEMNAME]\fR command may be inconvenient\. One can avoid waiting for \fBgem pristine \-\-all\fR, and instead run \fBbundle pristine\fR\.

data/man/bundle-pristine.1.txt

@@ -0,0 +1,44 @@
+BUNDLE-PRISTINE(1)					    BUNDLE-PRISTINE(1)
+
+
+
+NAME
+       bundle-pristine - Restores installed gems to their pristine condition
+
+SYNOPSIS
+       bundle pristine
+
+DESCRIPTION
+       pristine  restores  the	installed gems in the bundle to their pristine
+       condition using the local gem cache from  RubyGems.  For  git  gems,  a
+       forced checkout will be performed.
+
+       For  further  explanation,  bundle  pristine  ignores unpacked files on
+       disk. In other words, this command utilizes the local .gem cache or the
+       gem's git repository as if one were installing from scratch.
+
+       Note:  the  Bundler  gem  cannot be restored to its original state with
+       pristine. One also cannot use bundle pristine on  gems  with  a	'path'
+       option  in  the	Gemfile,  because  bundler has no original copy it can
+       restore from.
+
+       When is it practical to use bundle pristine?
+
+       It comes in handy when a developer is debugging a gem. bundle  pristine
+       is a great way to get rid of experimental changes to a gem that one may
+       not want.
+
+       Why use bundle pristine over gem pristine --all?
+
+       Both commands are very similar. For context: bundle  pristine,  without
+       arguments,  cleans  all gems from the lockfile. Meanwhile, gem pristine
+       --all cleans all installed gems for that Ruby version.
+
+       If a developer forgets which gems in their project they might have been
+       debugging,  the Rubygems gem pristine [GEMNAME] command may be inconve-
+       nient. One can avoid waiting for gem pristine --all,  and  instead  run
+       bundle pristine.
+
+
+
+				 November 2018		    BUNDLE-PRISTINE(1)

data/man/bundle-pristine.ronn

@@ -0,0 +1,34 @@
+bundle-pristine(1) -- Restores installed gems to their pristine condition
+===========================================================================
+
+## SYNOPSIS
+
+`bundle pristine`
+
+## DESCRIPTION
+
+`pristine` restores the installed gems in the bundle to their pristine condition
+using the local gem cache from RubyGems. For git gems, a forced checkout will be performed.
+
+For further explanation, `bundle pristine` ignores unpacked files on disk. In other
+words, this command utilizes the local `.gem` cache or the gem's git repository
+as if one were installing from scratch.
+
+Note: the Bundler gem cannot be restored to its original state with `pristine`.
+One also cannot use `bundle pristine` on gems with a 'path' option in the Gemfile,
+because bundler has no original copy it can restore from.
+
+When is it practical to use `bundle pristine`?
+
+It comes in handy when a developer is debugging a gem. `bundle pristine` is a
+great way to get rid of experimental changes to a gem that one may not want.
+
+Why use `bundle pristine` over `gem pristine --all`?
+
+Both commands are very similar.
+For context: `bundle pristine`, without arguments, cleans all gems from the lockfile.
+Meanwhile, `gem pristine --all` cleans all installed gems for that Ruby version.
+
+If a developer forgets which gems in their project they might
+have been debugging, the Rubygems `gem pristine [GEMNAME]` command may be inconvenient.
+One can avoid waiting for `gem pristine --all`, and instead run `bundle pristine`.

data/man/bundle-remove.1

@@ -0,0 +1,31 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "BUNDLE\-REMOVE" "1" "December 2018" "" ""
+.
+.SH "NAME"
+\fBbundle\-remove\fR \- Removes gems from the Gemfile
+.
+.SH "SYNOPSIS"
+\fBbundle remove [GEM [GEM \.\.\.]] [\-\-install]\fR
+.
+.SH "DESCRIPTION"
+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\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-\-install\fR
+Runs \fBbundle install\fR 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)\.
+.
+.P
+Example:
+.
+.P
+bundle remove rails
+.
+.P
+bundle remove rails rack
+.
+.P
+bundle remove rails rack \-\-install

data/man/bundle-remove.1.txt

@@ -0,0 +1,34 @@
+BUNDLE-REMOVE(1)					      BUNDLE-REMOVE(1)
+
+
+
+NAME
+       bundle-remove - Removes gems from the Gemfile
+
+SYNOPSIS
+       bundle remove [GEM [GEM ...]] [--install]
+
+DESCRIPTION
+       Removes the given gems from the Gemfile while ensuring that the result-
+       ing 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 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:
+
+       bundle remove rails
+
+       bundle remove rails rack
+
+       bundle remove rails rack --install
+
+
+
+				 December 2018		      BUNDLE-REMOVE(1)

data/man/bundle-remove.ronn

@@ -0,0 +1,23 @@
+bundle-remove(1) -- Removes gems from the Gemfile
+===========================================================================
+
+## SYNOPSIS
+
+`bundle remove [GEM [GEM ...]] [--install]`
+
+## DESCRIPTION
+
+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 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:
+
+bundle remove rails
+
+bundle remove rails rack
+
+bundle remove rails rack --install