summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorDavid Rodríguez <deivid.rodriguez@riseup.net>2019-10-20 13:26:11 +0200
committerDavid Rodríguez <deivid.rodriguez@riseup.net>2019-10-20 17:49:14 +0200
commitc9f6d2b4c5e540ba6a165c7a58432bf0081a7e32 (patch)
tree09de741504c82640e8a34f18932904db6ba5327a /man
parentc15f4a67432be1c125a606016c1db0fbdfe7f665 (diff)
downloadbundler-c9f6d2b4c5e540ba6a165c7a58432bf0081a7e32.tar.gz
Normalize "bundle cache" vs "bundle package"normalize_bundle_cache
Use the preferred `bundle cache` everywhere, but leave package as an alias. Remove duplicated tests.
Diffstat (limited to 'man')
-rw-r--r--man/bundle-cache.1 (renamed from man/bundle-package.1)16
-rw-r--r--man/bundle-cache.1.txt (renamed from man/bundle-package.1.txt)32
-rw-r--r--man/bundle-cache.ronn (renamed from man/bundle-package.ronn)18
-rw-r--r--man/index.txt2
4 files changed, 34 insertions, 34 deletions
diff --git a/man/bundle-package.1 b/man/bundle-cache.1
index 10231d7ad1..a3ffa0e7f7 100644
--- a/man/bundle-package.1
+++ b/man/bundle-cache.1
@@ -1,25 +1,25 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "BUNDLE\-PACKAGE" "1" "October 2019" "" ""
+.TH "BUNDLE\-CACHE" "1" "October 2019" "" ""
.
.SH "NAME"
-\fBbundle\-package\fR \- Package your needed \fB\.gem\fR files into your application
+\fBbundle\-cache\fR \- Package your needed \fB\.gem\fR files into your application
.
.SH "SYNOPSIS"
-\fBbundle package\fR
+\fBbundle cache\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 [bundle install(1)][bundle\-install], use the gems in the cache in preference to the ones on \fBrubygems\.org\fR\.
.
.SH "GIT AND PATH GEMS"
-The \fBbundle package\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\.
+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](bundle\-install\.1\.html) after running bundle package(1) \fIbundle\-package\.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\.
+By default, if you run \fBbundle install(1)\fR](bundle\-install\.1\.html) 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):
@@ -37,7 +37,7 @@ gem "nokogiri"
.IP "" 0
.
.P
-If you run \fBbundle package\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\.
+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\.
@@ -49,7 +49,7 @@ This problem is also not limited to the \fB"java"\fR platform\. A similar (commo
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 package\fR on an identical machine and check in the gems\. For instance, you can run \fBbundle package\fR on an identical staging box during your staging process, and check in the \fBvendor/cache\fR before deploying to production\.
+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 package(1) \fIbundle\-package\.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 package \-\-no\-install\fR\.
+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\.
diff --git a/man/bundle-package.1.txt b/man/bundle-cache.1.txt
index 707bec3cd6..1acac3d82d 100644
--- a/man/bundle-package.1.txt
+++ b/man/bundle-cache.1.txt
@@ -1,12 +1,12 @@
-BUNDLE-PACKAGE(1) BUNDLE-PACKAGE(1)
+BUNDLE-CACHE(1) BUNDLE-CACHE(1)
NAME
- bundle-package - Package your needed .gem files into your application
+ bundle-cache - Package your needed .gem files into your application
SYNOPSIS
- bundle package
+ bundle cache
DESCRIPTION
Copy all of the .gem files needed to run the application into the ven-
@@ -15,7 +15,7 @@ DESCRIPTION
the ones on rubygems.org.
GIT AND PATH GEMS
- The bundle package command can also package :git and :path dependencies
+ 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.
@@ -28,9 +28,9 @@ SUPPORT FOR MULTIPLE PLATFORMS
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.
+ 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):
@@ -42,9 +42,9 @@ REMOTE FETCHING
- 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"
+ 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
@@ -63,16 +63,16 @@ REMOTE FETCHING
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
+ 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 stag-
+ ing 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
+ 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 package --no-install.
+ you can run bundle cache --no-install.
- October 2019 BUNDLE-PACKAGE(1)
+ October 2019 BUNDLE-CACHE(1)
diff --git a/man/bundle-package.ronn b/man/bundle-cache.ronn
index ad745f8491..383adb2ba3 100644
--- a/man/bundle-package.ronn
+++ b/man/bundle-cache.ronn
@@ -1,9 +1,9 @@
-bundle-package(1) -- Package your needed `.gem` files into your application
+bundle-cache(1) -- Package your needed `.gem` files into your application
===========================================================================
## SYNOPSIS
-`bundle package`
+`bundle cache`
## DESCRIPTION
@@ -13,7 +13,7 @@ use the gems in the cache in preference to the ones on `rubygems.org`.
## GIT AND PATH GEMS
-The `bundle package` command can also package `:git` and `:path` dependencies
+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.
@@ -28,7 +28,7 @@ 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`
+[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`.
@@ -38,7 +38,7 @@ For instance, consider this Gemfile(5):
gem "nokogiri"
-If you run `bundle package` under C Ruby, bundler will retrieve
+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.
@@ -60,13 +60,13 @@ are appropriate for the platform you are on, you can run
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
+of all your gems is to run `bundle cache` on an identical
machine and check in the gems. For instance, you can run
-`bundle package` on an identical staging box during your
+`bundle cache` 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
+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 package --no-install`.
+local install location, you can run `bundle cache --no-install`.
diff --git a/man/index.txt b/man/index.txt
index 400eb02267..ef2956b2f9 100644
--- a/man/index.txt
+++ b/man/index.txt
@@ -2,6 +2,7 @@ Gemfile(5) gemfile.5
bundle(1) bundle.1
bundle-add(1) bundle-add.1
bundle-binstubs(1) bundle-binstubs.1
+bundle-cache(1) bundle-cache.1
bundle-check(1) bundle-check.1
bundle-clean(1) bundle-clean.1
bundle-config(1) bundle-config.1
@@ -16,7 +17,6 @@ bundle-list(1) bundle-list.1
bundle-lock(1) bundle-lock.1
bundle-open(1) bundle-open.1
bundle-outdated(1) bundle-outdated.1
-bundle-package(1) bundle-package.1
bundle-platform(1) bundle-platform.1
bundle-pristine(1) bundle-pristine.1
bundle-remove(1) bundle-remove.1