bundler 1.17.3 → 2.6.3

data/lib/bundler/man/bundle-cache.1

@@ -0,0 +1,68 @@
+.\" generated with Ronn-NG/v0.10.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
+.TH "BUNDLE\-CACHE" "1" "January 2025" ""
+.SH "NAME"
+\fBbundle\-cache\fR \- Package your needed \fB\.gem\fR files into your application
+.SH "SYNOPSIS"
+\fBbundle cache\fR [\fIOPTIONS\fR]
+.P
+alias: \fBpackage\fR, \fBpack\fR
+.SH "DESCRIPTION"
+Copy all of the \fB\.gem\fR files needed to run the application into the \fBvendor/cache\fR directory\. In the future, when running \fBbundle install(1)\fR \fIbundle\-install\.1\.html\fR, use the gems in the cache in preference to the ones on \fBrubygems\.org\fR\.
+.SH "OPTIONS"
+.TP
+\fB\-\-all\fR
+Include all sources (including path and git)\.
+.TP
+\fB\-\-all\-platforms\fR
+Include gems for all platforms present in the lockfile, not only the current one\.
+.TP
+\fB\-\-cache\-path=CACHE\-PATH\fR
+Specify a different cache path than the default (vendor/cache)\.
+.TP
+\fB\-\-gemfile=GEMFILE\fR
+Use the specified gemfile instead of Gemfile\.
+.TP
+\fB\-\-no\-install\fR
+Don't install the gems, only update the cache\.
+.TP
+\fB\-\-no\-prune\fR
+Don't remove stale gems from the cache\.
+.TP
+\fB\-\-path=PATH\fR
+Specify a different path than the system default ($BUNDLE_PATH or $GEM_HOME)\.
+.TP
+\fB\-\-quiet\fR
+Only output warnings and errors\.
+.TP
+\fB\-\-frozen\fR
+Do not allow the Gemfile\.lock to be updated after this bundle cache operation's install\.
+.SH "GIT AND PATH GEMS"
+The \fBbundle cache\fR command can also package \fB:git\fR and \fB:path\fR dependencies besides \.gem files\. This needs to be explicitly enabled via the \fB\-\-all\fR option\. Once used, the \fB\-\-all\fR option will be remembered\.
+.SH "SUPPORT FOR MULTIPLE PLATFORMS"
+When using gems that have different packages for different platforms, Bundler supports caching of gems for other platforms where the Gemfile has been resolved (i\.e\. present in the lockfile) in \fBvendor/cache\fR\. This needs to be enabled via the \fB\-\-all\-platforms\fR option\. This setting will be remembered in your local bundler configuration\.
+.SH "REMOTE FETCHING"
+By default, if you run \fBbundle install(1)\fR \fIbundle\-install\.1\.html\fR after running bundle cache(1) \fIbundle\-cache\.1\.html\fR, bundler will still connect to \fBrubygems\.org\fR to check whether a platform\-specific gem exists for any of the gems in \fBvendor/cache\fR\.
+.P
+For instance, consider this Gemfile(5):
+.IP "" 4
+.nf
+source "https://rubygems\.org"
+
+gem "nokogiri"
+.fi
+.IP "" 0
+.P
+If you run \fBbundle cache\fR under C Ruby, bundler will retrieve the version of \fBnokogiri\fR for the \fB"ruby"\fR platform\. If you deploy to JRuby and run \fBbundle install\fR, bundler is forced to check to see whether a \fB"java"\fR platformed \fBnokogiri\fR exists\.
+.P
+Even though the \fBnokogiri\fR gem for the Ruby platform is \fItechnically\fR acceptable on JRuby, it has a C extension that does not run on JRuby\. As a result, bundler will, by default, still connect to \fBrubygems\.org\fR to check whether it has a version of one of your gems more specific to your platform\.
+.P
+This problem is also not limited to the \fB"java"\fR 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\.
+.P
+If you know for sure that the gems packaged in \fBvendor/cache\fR are appropriate for the platform you are on, you can run \fBbundle install \-\-local\fR to skip checking for more appropriate gems, and use the ones in \fBvendor/cache\fR\.
+.P
+One way to be sure that you have the right platformed versions of all your gems is to run \fBbundle cache\fR on an identical machine and check in the gems\. For instance, you can run \fBbundle cache\fR on an identical staging box during your staging process, and check in the \fBvendor/cache\fR before deploying to production\.
+.P
+By default, bundle cache(1) \fIbundle\-cache\.1\.html\fR fetches and also installs the gems to the default location\. To package the dependencies to \fBvendor/cache\fR without installing them to the local install location, you can run \fBbundle cache \-\-no\-install\fR\.
+.SH "HISTORY"
+In Bundler 2\.1, \fBcache\fR took in the functionalities of \fBpackage\fR and now \fBpackage\fR and \fBpack\fR are aliases of \fBcache\fR\.

data/lib/bundler/man/bundle-cache.1.ronn

@@ -0,0 +1,108 @@
+bundle-cache(1) -- Package your needed `.gem` files into your application
+=========================================================================
+
+## SYNOPSIS
+
+`bundle cache` [*OPTIONS*]
+
+alias: `package`, `pack`
+
+## DESCRIPTION
+
+Copy all of the `.gem` files needed to run the application into the
+`vendor/cache` directory. In the future, when running [`bundle install(1)`](bundle-install.1.html),
+use the gems in the cache in preference to the ones on `rubygems.org`.
+
+## OPTIONS
+
+* `--all`:
+  Include all sources (including path and git).
+
+* `--all-platforms`:
+  Include gems for all platforms present in the lockfile, not only the current one.
+
+* `--cache-path=CACHE-PATH`:
+  Specify a different cache path than the default (vendor/cache).
+
+* `--gemfile=GEMFILE`:
+  Use the specified gemfile instead of Gemfile.
+
+* `--no-install`:
+  Don't install the gems, only update the cache.
+
+* `--no-prune`:
+  Don't remove stale gems from the cache.
+
+* `--path=PATH`:
+  Specify a different path than the system default ($BUNDLE_PATH or $GEM_HOME).
+
+* `--quiet`:
+  Only output warnings and errors.
+
+* `--frozen`:
+  Do not allow the Gemfile.lock to be updated after this bundle cache operation's install.
+
+## GIT AND PATH GEMS
+
+The `bundle cache` 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
+supports 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 run [`bundle install(1)`](bundle-install.1.html) after running
+[bundle cache(1)](bundle-cache.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 cache` under C Ruby, bundler will retrieve
+the version 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 appropriate for the platform you are on, you can run
+`bundle install --local` to skip checking for more appropriate
+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 cache` on an identical
+machine and check in the gems. For instance, you can run
+`bundle cache` on an identical staging box during your
+staging process, and check in the `vendor/cache` before
+deploying to production.
+
+By default, [bundle cache(1)](bundle-cache.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 cache --no-install`.
+
+## HISTORY
+
+In Bundler 2.1, `cache` took in the functionalities of `package` and now
+`package` and `pack` are aliases of `cache`.

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

@@ -1,31 +1,24 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "BUNDLE\-CHECK" "1" "November 2018" "" ""
-.
+.\" generated with Ronn-NG/v0.10.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
+.TH "BUNDLE\-CHECK" "1" "January 2025" ""
 .SH "NAME"
 \fBbundle\-check\fR \- Verifies if dependencies are satisfied by installed gems
-.
 .SH "SYNOPSIS"
 \fBbundle check\fR [\-\-dry\-run] [\-\-gemfile=FILE] [\-\-path=PATH]
-.
 .SH "DESCRIPTION"
 \fBcheck\fR searches the local machine for each of the gems requested in the Gemfile\. If all gems are found, Bundler prints a success message and exits with a status of 0\.
-.
 .P
 If not, the first missing gem is listed and Bundler exits status 1\.
-.
+.P
+If the lockfile needs to be updated then it will be resolved using the gems installed on the local machine, if they satisfy the requirements\.
 .SH "OPTIONS"
-.
 .TP
 \fB\-\-dry\-run\fR
 Locks the [\fBGemfile(5)\fR][Gemfile(5)] before running the command\.
-.
 .TP
-\fB\-\-gemfile\fR
+\fB\-\-gemfile=GEMFILE\fR
 Use the specified gemfile instead of the [\fBGemfile(5)\fR][Gemfile(5)]\.
-.
 .TP
-\fB\-\-path\fR
+\fB\-\-path=PATH\fR
 Specify a different path than the system default (\fB$BUNDLE_PATH\fR or \fB$GEM_HOME\fR)\. Bundler will remember this value for future installs on this machine\.
 

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

@@ -15,12 +15,17 @@ a status of 0.
 
 If not, the first missing gem is listed and Bundler exits status 1.
 
+If the lockfile needs to be updated then it will be resolved using the gems
+installed on the local machine, if they satisfy the requirements.
+
 ## OPTIONS
 
 * `--dry-run`:
   Locks the [`Gemfile(5)`][Gemfile(5)] before running the command.
-* `--gemfile`:
+
+* `--gemfile=GEMFILE`:
   Use the specified gemfile instead of the [`Gemfile(5)`][Gemfile(5)].
-* `--path`:
+
+* `--path=PATH`:
   Specify a different path than the system default (`$BUNDLE_PATH` or `$GEM_HOME`).
   Bundler will remember this value for future installs on this machine.

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

@@ -1,24 +1,17 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "BUNDLE\-CLEAN" "1" "December 2018" "" ""
-.
+.\" generated with Ronn-NG/v0.10.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
+.TH "BUNDLE\-CLEAN" "1" "January 2025" ""
 .SH "NAME"
 \fBbundle\-clean\fR \- Cleans up unused gems in your bundler directory
-.
 .SH "SYNOPSIS"
 \fBbundle clean\fR [\-\-dry\-run] [\-\-force]
-.
 .SH "DESCRIPTION"
 This command will remove all unused gems in your bundler directory\. This is useful when you have made many changes to your gem dependencies\.
-.
 .SH "OPTIONS"
-.
 .TP
 \fB\-\-dry\-run\fR
 Print the changes, but do not clean the unused gems\.
-.
 .TP
 \fB\-\-force\fR
-Force a clean even if \fB\-\-path\fR is not set\.
+Forces cleaning up unused gems even if Bundler is configured to use globally installed gems\. As a consequence, removes all system gems except for the ones in the current application\.
 

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

@@ -15,4 +15,4 @@ useful when you have made many changes to your gem dependencies.
 * `--dry-run`:
   Print the changes, but do not clean the unused gems.
 * `--force`:
-  Force a clean even if `--path` is not set.
+  Forces cleaning up unused gems even if Bundler is configured to use globally installed gems. As a consequence, removes all system gems except for the ones in the current application.