summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorhsbt <hsbt@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2018-12-11 03:07:37 (GMT)
committerhsbt <hsbt@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2018-12-11 03:07:37 (GMT)
commit91533d9ab17a08385381d87991e01e8674e069a1 (patch)
treed12a91bc6cf5a524712a87e94a99345983f4806b /man
parent448e86d796b67d4535c2443f379031ace3388f60 (diff)
Downgrade Bundler 1.17.x from 2.0.0.
We have the platform issue on heroku: * https://gist.github.com/schneems/26452540f6e2bbbcf2ea144f45f6b305 * https://github.com/heroku/heroku-buildpack-ruby/issues/833 git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@66323 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'man')
-rw-r--r--man/bundle-config.14
-rw-r--r--man/bundle-config.1.txt6
-rw-r--r--man/bundle-install.113
-rw-r--r--man/bundle-install.1.txt231
-rw-r--r--man/bundle-update.18
-rw-r--r--man/bundle-update.1.txt125
6 files changed, 190 insertions, 197 deletions
diff --git a/man/bundle-config.1 b/man/bundle-config.1
index 8c0b368..80ef0c0 100644
--- a/man/bundle-config.1
+++ b/man/bundle-config.1
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "BUNDLE\-CONFIG" "1" "November 2018" "" ""
+.TH "BUNDLE\-CONFIG" "1" "December 2018" "" ""
.
.SH "NAME"
\fBbundle\-config\fR \- Set bundler configuration options
@@ -238,7 +238,7 @@ The following is a list of all configuration keys and their purpose\. You can le
\fBpath\.system\fR (\fBBUNDLE_PATH__SYSTEM\fR): Whether Bundler will install gems into the default system path (\fBGem\.dir\fR)\.
.
.IP "\(bu" 4
-\fBpath_relative_to_cwd\fR (\fBBUNDLE_PATH_RELATIVE_TO_CWD\fR) Makes \fB\-\-path\fR relative to the CWD instead of the \fBGemfile\fR\.
+\fBpath_relative_to_cwd\fR (\fBPATH_RELATIVE_TO_CWD\fR) Makes \fB\-\-path\fR relative to the CWD instead of the \fBGemfile\fR\.
.
.IP "\(bu" 4
\fBplugins\fR (\fBBUNDLE_PLUGINS\fR): Enable Bundler\'s experimental plugin system\.
diff --git a/man/bundle-config.1.txt b/man/bundle-config.1.txt
index 9b07159..f8f421c 100644
--- a/man/bundle-config.1.txt
+++ b/man/bundle-config.1.txt
@@ -282,8 +282,8 @@ BUNDLE-CONFIG(1) BUNDLE-CONFIG(1)
o 1mpath.system 22m(1mBUNDLE_PATH__SYSTEM22m): Whether Bundler will install
gems into the default system path (1mGem.dir22m).
- o 1mpath_relative_to_cwd 22m(1mBUNDLE_PATH_RELATIVE_TO_CWD22m) Makes 1m--path0m
- relative to the CWD instead of the 1mGemfile22m.
+ o 1mpath_relative_to_cwd 22m(1mPATH_RELATIVE_TO_CWD22m) Makes 1m--path 22mrelative
+ to the CWD instead of the 1mGemfile22m.
o 1mplugins 22m(1mBUNDLE_PLUGINS22m): Enable Bundler's experimental plugin sys-
tem.
@@ -526,4 +526,4 @@ BUNDLE-CONFIG(1) BUNDLE-CONFIG(1)
- November 2018 BUNDLE-CONFIG(1)
+ December 2018 BUNDLE-CONFIG(1)
diff --git a/man/bundle-install.1 b/man/bundle-install.1
index 2549562..c70f92e 100644
--- a/man/bundle-install.1
+++ b/man/bundle-install.1
@@ -1,13 +1,13 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "BUNDLE\-INSTALL" "1" "November 2018" "" ""
+.TH "BUNDLE\-INSTALL" "1" "December 2018" "" ""
.
.SH "NAME"
\fBbundle\-install\fR \- Install the dependencies specified in your Gemfile
.
.SH "SYNOPSIS"
-\fBbundle install\fR [\-\-binstubs[=DIRECTORY]] [\-\-clean] [\-\-deployment] [\-\-frozen] [\-\-full\-index] [\-\-gemfile=GEMFILE] [\-\-jobs=NUMBER] [\-\-local] [\-\-no\-cache] [\-\-no\-prune] [\-\-path PATH] [\-\-quiet] [\-\-redownload] [\-\-retry=NUMBER] [\-\-shebang] [\-\-standalone[=GROUP[ GROUP\.\.\.]]] [\-\-system] [\-\-trust\-policy=POLICY] [\-\-with=GROUP[ GROUP\.\.\.]] [\-\-without=GROUP[ GROUP\.\.\.]]
+\fBbundle install\fR [\-\-binstubs[=DIRECTORY]] [\-\-clean] [\-\-deployment] [\-\-force] [\-\-frozen] [\-\-full\-index] [\-\-gemfile=GEMFILE] [\-\-jobs=NUMBER] [\-\-local] [\-\-no\-cache] [\-\-no\-prune] [\-\-path PATH] [\-\-quiet] [\-\-retry=NUMBER] [\-\-shebang] [\-\-standalone[=GROUP[ GROUP\.\.\.]]] [\-\-system] [\-\-trust\-policy=POLICY] [\-\-with=GROUP[ GROUP\.\.\.]] [\-\-without=GROUP[ GROUP\.\.\.]]
.
.SH "DESCRIPTION"
Install the gems specified in your Gemfile(5)\. If this is the first time you run bundle install (and a \fBGemfile\.lock\fR does not exist), Bundler will fetch all remote sources, resolve dependencies and install all needed gems\.
@@ -23,10 +23,7 @@ To apply any of \fB\-\-binstubs\fR, \fB\-\-deployment\fR, \fB\-\-path\fR, or \fB
.
.TP
\fB\-\-binstubs[=<directory>]\fR
-Binstubs are scripts that wrap around executables\. Bundler creates a small Ruby file (a binstub) that loads Bundler, runs the command, and puts it in \fBbin/\fR\. This lets you link the binstub inside of an application to the exact gem version the application needs\.
-.
-.IP
-Creates a directory (defaults to \fB~/bin\fR) and places any executables from the gem there\. These executables run in Bundler\'s context\. If used, you might add this directory to your environment\'s \fBPATH\fR variable\. For instance, if the \fBrails\fR gem comes with a \fBrails\fR executable, this flag will create a \fBbin/rails\fR executable that ensures that all referred dependencies will be resolved using the bundled gems\.
+Creates a directory (defaults to \fB~/bin\fR) and place any executables from the gem there\. These executables run in Bundler\'s context\. If used, you might add this directory to your environment\'s \fBPATH\fR variable\. For instance, if the \fBrails\fR gem comes with a \fBrails\fR executable, this flag will create a \fBbin/rails\fR executable that ensures that all referred dependencies will be resolved using the bundled gems\.
.
.TP
\fB\-\-clean\fR
@@ -37,8 +34,8 @@ On finishing the installation Bundler is going to remove any gems not present in
In \fIdeployment mode\fR, 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\.
.
.TP
-\fB\-\-redownload\fR
-Force download every gem, even if the required versions are already available locally\.
+\fB\-\-force\fR
+Force download every gem, even if the required versions are already available locally\. \fB\-\-redownload\fR is an alias of this option\.
.
.TP
\fB\-\-frozen\fR
diff --git a/man/bundle-install.1.txt b/man/bundle-install.1.txt
index 004a522..9311862 100644
--- a/man/bundle-install.1.txt
+++ b/man/bundle-install.1.txt
@@ -7,8 +7,8 @@ BUNDLE-INSTALL(1) BUNDLE-INSTALL(1)
1mSYNOPSIS0m
1mbundle install 22m[--binstubs[=DIRECTORY]] [--clean] [--deployment]
- [--frozen] [--full-index] [--gemfile=GEMFILE] [--jobs=NUMBER] [--local]
- [--no-cache] [--no-prune] [--path PATH] [--quiet] [--redownload]
+ [--force] [--frozen] [--full-index] [--gemfile=GEMFILE] [--jobs=NUMBER]
+ [--local] [--no-cache] [--no-prune] [--path PATH] [--quiet]
[--retry=NUMBER] [--shebang] [--standalone[=GROUP[ GROUP...]]] [--sys-
tem] [--trust-policy=POLICY] [--with=GROUP[ GROUP...]] [--with-
out=GROUP[ GROUP...]]
@@ -34,13 +34,7 @@ BUNDLE-INSTALL(1) BUNDLE-INSTALL(1)
time 1mbundle install 22mis run, use 1mbundle config 22m(see bundle-config(1)).
1m--binstubs[=<directory>]0m
- Binstubs are scripts that wrap around executables. Bundler cre-
- ates a small Ruby file (a binstub) that loads Bundler, runs the
- command, and puts it in 1mbin/22m. This lets you link the binstub
- inside of an application to the exact gem version the applica-
- tion needs.
-
- Creates a directory (defaults to 1m~/bin22m) and places any executa-
+ Creates a directory (defaults to 1m~/bin22m) and place any executa-
bles from the gem there. These executables run in Bundler's con-
text. If used, you might add this directory to your environ-
ment's 1mPATH 22mvariable. For instance, if the 1mrails 22mgem comes with
@@ -58,57 +52,58 @@ BUNDLE-INSTALL(1) BUNDLE-INSTALL(1)
duction or CI use. Please check carefully if you want to have
this option enabled in your development environment.
- 1m--redownload0m
+ 1m--force0m
Force download every gem, even if the required versions are
- already available locally.
+ already available locally. 1m--redownload 22mis an alias of this
+ option.
1m--frozen0m
- Do not allow the Gemfile.lock to be updated after this install.
- Exits non-zero if there are going to be changes to the Gem-
+ Do not allow the Gemfile.lock to be updated after this install.
+ Exits non-zero if there are going to be changes to the Gem-
file.lock.
1m--full-index0m
Bundler will not call Rubygems' API endpoint (default) but down-
load and cache a (currently big) index file of all gems. Perfor-
- mance can be improved for large bundles that seldom change by
+ mance can be improved for large bundles that seldom change by
enabling this option.
1m--gemfile=<gemfile>0m
- The location of the Gemfile(5) which Bundler should use. This
- defaults to a Gemfile(5) in the current working directory. In
+ The location of the Gemfile(5) which Bundler should use. This
+ defaults to a Gemfile(5) in the current working directory. In
general, Bundler will assume that the location of the Gemfile(5)
is also the project's root and will try to find 1mGemfile.lock 22mand
1mvendor/cache 22mrelative to this location.
1m--jobs=[<number>]22m, 1m-j[<number>]0m
- The maximum number of parallel download and install jobs. The
+ The maximum number of parallel download and install jobs. The
default is 1m122m.
1m--local0m
Do not attempt to connect to 1mrubygems.org22m. Instead, Bundler will
- use the gems already present in Rubygems' cache or in 1mven-0m
- 1mdor/cache22m. Note that if a appropriate platform-specific gem
+ use the gems already present in Rubygems' cache or in 1mven-0m
+ 1mdor/cache22m. Note that if a appropriate platform-specific gem
exists on 1mrubygems.org 22mit will not be found.
1m--no-cache0m
- Do not update the cache in 1mvendor/cache 22mwith the newly bundled
- gems. This does not remove any gems in the cache but keeps the
+ Do not update the cache in 1mvendor/cache 22mwith the newly bundled
+ gems. This does not remove any gems in the cache but keeps the
newly bundled gems from being cached during the install.
1m--no-prune0m
- Don't remove stale gems from the cache when the installation
+ Don't remove stale gems from the cache when the installation
finishes.
1m--path=<path>0m
- The location to install the specified gems to. This defaults to
- Rubygems' setting. Bundler shares this location with Rubygems,
- 1mgem install ... 22mwill have gem installed there, too. Therefore,
- gems installed without a 1m--path ... 22msetting will show up by
+ The location to install the specified gems to. This defaults to
+ Rubygems' setting. Bundler shares this location with Rubygems,
+ 1mgem install ... 22mwill have gem installed there, too. Therefore,
+ gems installed without a 1m--path ... 22msetting will show up by
calling 1mgem list22m. Accordingly, gems installed to other locations
will not get listed.
1m--quiet0m
- Do not print progress information to the standard output.
+ Do not print progress information to the standard output.
Instead, Bundler will exit using a status code (1m$?22m).
1m--retry=[<number>]0m
@@ -116,34 +111,34 @@ BUNDLE-INSTALL(1) BUNDLE-INSTALL(1)
1m--shebang=<ruby-executable>0m
Uses the specified ruby executable (usually 1mruby22m) to execute the
- scripts created with 1m--binstubs22m. In addition, if you use 1m--bin-0m
- 1mstubs 22mtogether with 1m--shebang jruby 22mthese executables will be
+ scripts created with 1m--binstubs22m. In addition, if you use 1m--bin-0m
+ 1mstubs 22mtogether with 1m--shebang jruby 22mthese executables will be
changed to execute 1mjruby 22minstead.
1m--standalone[=<list>]0m
- Makes a bundle that can work without depending on Rubygems or
- Bundler at runtime. A space separated list of groups to install
- has to be specified. Bundler creates a directory named 1mbundle0m
+ Makes a bundle that can work without depending on Rubygems or
+ Bundler at runtime. A space separated list of groups to install
+ has to be specified. Bundler creates a directory named 1mbundle0m
and installs the bundle there. It also generates a 1mbun-0m
- 1mdle/bundler/setup.rb 22mfile to replace Bundler's own setup in the
- manner required. Using this option implicitly sets 1mpath22m, which
+ 1mdle/bundler/setup.rb 22mfile to replace Bundler's own setup in the
+ manner required. Using this option implicitly sets 1mpath22m, which
is a [remembered option][REMEMBERED OPTIONS].
1m--system0m
- Installs the gems specified in the bundle to the system's
- Rubygems location. This overrides any previous configuration of
+ Installs the gems specified in the bundle to the system's
+ Rubygems location. This overrides any previous configuration of
1m--path22m.
1m--trust-policy=[<policy>]0m
- Apply the Rubygems security policy 4mpolicy24m, where policy is one
- of 1mHighSecurity22m, 1mMediumSecurity22m, 1mLowSecurity22m, 1mAlmostNoSecurity22m,
+ Apply the Rubygems security policy 4mpolicy24m, where policy is one
+ of 1mHighSecurity22m, 1mMediumSecurity22m, 1mLowSecurity22m, 1mAlmostNoSecurity22m,
or 1mNoSecurity22m. For more details, please see the Rubygems signing
documentation linked below in 4mSEE24m 4mALSO24m.
1m--with=<list>0m
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
+ 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.
1m--without=<list>0m
@@ -153,41 +148,41 @@ BUNDLE-INSTALL(1) BUNDLE-INSTALL(1)
1mDEPLOYMENT MODE0m
Bundler's defaults are optimized for development. To switch to defaults
- optimized for deployment and for CI, use the 1m--deployment 22mflag. Do not
- activate deployment mode on development machines, as it will cause an
+ optimized for deployment and for CI, use the 1m--deployment 22mflag. Do not
+ activate deployment mode on development machines, as it will cause an
error when the Gemfile(5) is modified.
1. A 1mGemfile.lock 22mis required.
To ensure that the same versions of the gems you developed with and
- tested with are also used in deployments, a 1mGemfile.lock 22mis
+ tested with are also used in deployments, a 1mGemfile.lock 22mis
required.
- This is mainly to ensure that you remember to check your 1mGem-0m
+ This is mainly to ensure that you remember to check your 1mGem-0m
1mfile.lock 22minto version control.
2. The 1mGemfile.lock 22mmust be up to date
- In development, you can modify your Gemfile(5) and re-run 1mbundle0m
+ In development, you can modify your Gemfile(5) and re-run 1mbundle0m
1minstall 22mto 4mconservatively24m 4mupdate24m your 1mGemfile.lock 22msnapshot.
- In deployment, your 1mGemfile.lock 22mshould be up-to-date with changes
+ In deployment, your 1mGemfile.lock 22mshould be up-to-date with changes
made in your Gemfile(5).
- 3. Gems are installed to 1mvendor/bundle 22mnot your default system loca-
+ 3. Gems are installed to 1mvendor/bundle 22mnot your default system loca-
tion
- In development, it's convenient to share the gems used in your
- application with other applications and other scripts that run on
+ In development, it's convenient to share the gems used in your
+ application with other applications and other scripts that run on
the system.
- In deployment, isolation is a more important default. In addition,
- the user deploying the application may not have permission to
- install gems to the system, or the web server may not have permis-
+ In deployment, isolation is a more important default. In addition,
+ the user deploying the application may not have permission to
+ install gems to the system, or the web server may not have permis-
sion to read them.
- As a result, 1mbundle install --deployment 22minstalls gems to the 1mven-0m
- 1mdor/bundle 22mdirectory in the application. This may be overridden
+ As a result, 1mbundle install --deployment 22minstalls gems to the 1mven-0m
+ 1mdor/bundle 22mdirectory in the application. This may be overridden
using the 1m--path 22moption.
@@ -195,12 +190,12 @@ BUNDLE-INSTALL(1) BUNDLE-INSTALL(1)
1mSUDO USAGE0m
By default, Bundler installs gems to the same location as 1mgem install22m.
- In some cases, that location may not be writable by your Unix user. In
+ In some cases, that location may not be writable by your Unix user. In
that case, Bundler will stage everything in a temporary directory, then
- ask you for your 1msudo 22mpassword in order to copy the gems into their
+ ask you for your 1msudo 22mpassword in order to copy the gems into their
system location.
- From your perspective, this is identical to installing the gems
+ From your perspective, this is identical to installing the gems
directly into the system.
You should never use 1msudo bundle install22m. This is because several other
@@ -214,36 +209,36 @@ BUNDLE-INSTALL(1) BUNDLE-INSTALL(1)
- Of these three, the first two could theoretically be performed by
- 1mchown22ming the resulting files to 1m$SUDO_USER22m. The third, however, can
- only be performed by invoking the 1mgit 22mcommand as the current user.
- Therefore, git gems are downloaded and installed into 1m~/.bundle 22mrather
+ Of these three, the first two could theoretically be performed by
+ 1mchown22ming the resulting files to 1m$SUDO_USER22m. The third, however, can
+ only be performed by invoking the 1mgit 22mcommand as the current user.
+ Therefore, git gems are downloaded and installed into 1m~/.bundle 22mrather
than $GEM_HOME or $BUNDLE_PATH.
- As a result, you should run 1mbundle install 22mas the current user, and
+ As a result, you should run 1mbundle install 22mas the current user, and
Bundler will ask for your password if it is needed to put the gems into
their final location.
1mINSTALLING GROUPS0m
- By default, 1mbundle install 22mwill install all gems in all groups in your
+ By default, 1mbundle install 22mwill install all gems in all groups in your
Gemfile(5), except those declared for a different platform.
- However, you can explicitly tell Bundler to skip installing certain
- groups with the 1m--without 22moption. This option takes a space-separated
+ However, you can explicitly tell Bundler to skip installing certain
+ groups with the 1m--without 22moption. This option takes a space-separated
list of groups.
- While the 1m--without 22moption will skip 4minstalling24m the gems in the speci-
- fied groups, it will still 4mdownload24m those gems and use them to resolve
+ While the 1m--without 22moption will skip 4minstalling24m the gems in the speci-
+ fied groups, it will still 4mdownload24m those gems and use them to resolve
the dependencies of every gem in your Gemfile(5).
This is so that installing a different set of groups on another machine
- (such as a production server) will not change the gems and versions
+ (such as a production server) will not change the gems and versions
that you have already developed and tested against.
1mBundler offers a rock-solid guarantee that the third-party code you are0m
1mrunning in development and testing is also the third-party code you are0m
- 1mrunning in production. You can choose to exclude some of that code in0m
- 1mdifferent environments, but you will never be caught flat-footed by0m
+ 1mrunning in production. You can choose to exclude some of that code in0m
+ 1mdifferent environments, but you will never be caught flat-footed by0m
1mdifferent versions of third-party code being used in different environ-0m
1mments.0m
@@ -261,63 +256,63 @@ BUNDLE-INSTALL(1) BUNDLE-INSTALL(1)
- In this case, 1msinatra 22mdepends on any version of Rack (1m>= 1.022m), while
+ In this case, 1msinatra 22mdepends on any version of Rack (1m>= 1.022m), while
1mrack-perftools-profiler 22mdepends on 1.x (1m~> 1.022m).
- When you run 1mbundle install --without production 22min development, we
- look at the dependencies of 1mrack-perftools-profiler 22mas well. That way,
- you do not spend all your time developing against Rack 2.0, using new
- APIs unavailable in Rack 1.x, only to have Bundler switch to Rack 1.2
+ When you run 1mbundle install --without production 22min development, we
+ look at the dependencies of 1mrack-perftools-profiler 22mas well. That way,
+ you do not spend all your time developing against Rack 2.0, using new
+ APIs unavailable in Rack 1.x, only to have Bundler switch to Rack 1.2
when the 1mproduction 22mgroup 4mis24m used.
- This should not cause any problems in practice, because we do not
- attempt to 1minstall 22mthe gems in the excluded groups, and only evaluate
+ This should not cause any problems in practice, because we do not
+ attempt to 1minstall 22mthe gems in the excluded groups, and only evaluate
as part of the dependency resolution process.
- This also means that you cannot include different versions of the same
- gem in different groups, because doing so would result in different
+ This also means that you cannot include different versions of the same
+ gem in different groups, because doing so would result in different
sets of dependencies used in development and production. Because of the
- vagaries of the dependency resolution process, this usually affects
- more than the gems you list in your Gemfile(5), and can (surprisingly)
+ vagaries of the dependency resolution process, this usually affects
+ more than the gems you list in your Gemfile(5), and can (surprisingly)
radically change the gems you are using.
1mTHE GEMFILE.LOCK0m
- When you run 1mbundle install22m, Bundler will persist the full names and
- versions of all gems that you used (including dependencies of the gems
+ When you run 1mbundle install22m, Bundler will persist the full names and
+ versions of all gems that you used (including dependencies of the gems
specified in the Gemfile(5)) into a file called 1mGemfile.lock22m.
Bundler uses this file in all subsequent calls to 1mbundle install22m, which
guarantees that you always use the same exact code, even as your appli-
cation moves across machines.
- Because of the way dependency resolution works, even a seemingly small
+ Because of the way dependency resolution works, even a seemingly small
change (for instance, an update to a point-release of a dependency of a
- gem in your Gemfile(5)) can result in radically different gems being
+ gem in your Gemfile(5)) can result in radically different gems being
needed to satisfy all dependencies.
- As a result, you 1mSHOULD 22mcheck your 1mGemfile.lock 22minto version control,
+ As a result, you 1mSHOULD 22mcheck your 1mGemfile.lock 22minto version 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
+ dependencies again, which will result in different versions of
third-party code being used if 1many 22mof the gems in the Gemfile(5) or any
of their dependencies have been updated.
- When Bundler first shipped, the 1mGemfile.lock 22mwas included in the 1m.git-0m
+ When Bundler first shipped, the 1mGemfile.lock 22mwas included in the 1m.git-0m
1mignore 22mfile included with generated gems. Over time, however, it became
- clear that this practice forces the pain of broken dependencies onto
+ clear that this practice forces the pain of broken dependencies onto
new contributors, while leaving existing contributors potentially
- unaware of the problem. Since 1mbundle install 22mis usually the first step
- towards a contribution, the pain of broken dependencies would discour-
- age new contributors from contributing. As a result, we have revised
- our guidance for gem authors to now recommend checking in the lock for
+ unaware of the problem. Since 1mbundle install 22mis usually the first step
+ towards a contribution, the pain of broken dependencies would discour-
+ age new contributors from contributing. As a result, we have revised
+ our guidance for gem authors to now recommend checking in the lock for
gems.
1mCONSERVATIVE UPDATING0m
- When you make a change to the Gemfile(5) and then run 1mbundle install22m,
+ When you make a change to the Gemfile(5) and then run 1mbundle install22m,
Bundler will update only the gems that you modified.
- In other words, if a gem that you 1mdid not modify 22mworked before you
- called 1mbundle install22m, it will continue to use the exact same versions
+ In other words, if a gem that you 1mdid not modify 22mworked before you
+ called 1mbundle install22m, it will continue to use the exact same versions
of all dependencies as it used before the update.
Let's take a look at an example. Here's your original Gemfile(5):
@@ -331,13 +326,13 @@ BUNDLE-INSTALL(1) BUNDLE-INSTALL(1)
- In this case, both 1mactionpack 22mand 1mactivemerchant 22mdepend on 1mactivesup-0m
- 1mport22m. The 1mactionpack 22mgem depends on 1mactivesupport 2.3.8 22mand 1mrack ~>0m
- 1m1.1.022m, while the 1mactivemerchant 22mgem depends on 1mactivesupport >= 2.3.222m,
+ In this case, both 1mactionpack 22mand 1mactivemerchant 22mdepend on 1mactivesup-0m
+ 1mport22m. The 1mactionpack 22mgem depends on 1mactivesupport 2.3.8 22mand 1mrack ~>0m
+ 1m1.1.022m, while the 1mactivemerchant 22mgem depends on 1mactivesupport >= 2.3.222m,
1mbraintree >= 2.0.022m, and 1mbuilder >= 2.0.022m.
- When the dependencies are first resolved, Bundler will select
- 1mactivesupport 2.3.822m, which satisfies the requirements of both gems in
+ When the dependencies are first resolved, Bundler will select
+ 1mactivesupport 2.3.822m, which satisfies the requirements of both gems in
your Gemfile(5).
Next, you modify your Gemfile(5) to:
@@ -351,44 +346,44 @@ BUNDLE-INSTALL(1) BUNDLE-INSTALL(1)
- The 1mactionpack 3.0.0.rc 22mgem has a number of new dependencies, and
- updates the 1mactivesupport 22mdependency to 1m= 3.0.0.rc 22mand the 1mrack 22mdepen-
+ The 1mactionpack 3.0.0.rc 22mgem has a number of new dependencies, and
+ updates the 1mactivesupport 22mdependency to 1m= 3.0.0.rc 22mand the 1mrack 22mdepen-
dency to 1m~> 1.2.122m.
- When you run 1mbundle install22m, Bundler notices that you changed the
- 1mactionpack 22mgem, but not the 1mactivemerchant 22mgem. It evaluates the gems
+ When you run 1mbundle install22m, Bundler notices that you changed the
+ 1mactionpack 22mgem, but not the 1mactivemerchant 22mgem. It evaluates the gems
currently being used to satisfy its requirements:
1mactivesupport 2.3.80m
- also used to satisfy a dependency in 1mactivemerchant22m, which is
+ also used to satisfy a dependency in 1mactivemerchant22m, which is
not being updated
1mrack ~> 1.1.00m
not currently being used to satisfy another dependency
- Because you did not explicitly ask to update 1mactivemerchant22m, you would
- not expect it to suddenly stop working after updating 1mactionpack22m. How-
- ever, satisfying the new 1mactivesupport 3.0.0.rc 22mdependency of action-
+ Because you did not explicitly ask to update 1mactivemerchant22m, you would
+ not expect it to suddenly stop working after updating 1mactionpack22m. How-
+ ever, satisfying the new 1mactivesupport 3.0.0.rc 22mdependency of action-
pack requires updating one of its dependencies.
- Even though 1mactivemerchant 22mdeclares a very loose dependency that theo-
- retically matches 1mactivesupport 3.0.0.rc22m, Bundler treats gems in your
- Gemfile(5) that have not changed as an atomic unit together with their
+ Even though 1mactivemerchant 22mdeclares a very loose dependency that theo-
+ retically matches 1mactivesupport 3.0.0.rc22m, Bundler treats gems in your
+ Gemfile(5) that have not changed as an atomic unit together with their
dependencies. In this case, the 1mactivemerchant 22mdependency is treated as
- 1mactivemerchant 1.7.1 + activesupport 2.3.822m, so 1mbundle install 22mwill
+ 1mactivemerchant 1.7.1 + activesupport 2.3.822m, so 1mbundle install 22mwill
report that it cannot update 1mactionpack22m.
To explicitly update 1mactionpack22m, including its dependencies which other
- gems in the Gemfile(5) still depend on, run 1mbundle update actionpack0m
+ gems in the Gemfile(5) still depend on, run 1mbundle update actionpack0m
(see 1mbundle update(1)22m).
- 1mSummary22m: In general, after making a change to the Gemfile(5) , you
- should first try to run 1mbundle install22m, which will guarantee that no
+ 1mSummary22m: In general, after making a change to the Gemfile(5) , you
+ should first try to run 1mbundle install22m, 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) 4mbundle-update.1.html24m.
1mSEE ALSO0m
- o Gem install docs
+ o Gem install docs
4mhttp://guides.rubygems.org/rubygems-basics/#installing-gems0m
o Rubygems signing docs 4mhttp://guides.rubygems.org/security/0m
@@ -398,4 +393,4 @@ BUNDLE-INSTALL(1) BUNDLE-INSTALL(1)
- November 2018 BUNDLE-INSTALL(1)
+ December 2018 BUNDLE-INSTALL(1)
diff --git a/man/bundle-update.1 b/man/bundle-update.1
index 3a303b5..1fe205c 100644
--- a/man/bundle-update.1
+++ b/man/bundle-update.1
@@ -1,13 +1,13 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "BUNDLE\-UPDATE" "1" "November 2018" "" ""
+.TH "BUNDLE\-UPDATE" "1" "December 2018" "" ""
.
.SH "NAME"
\fBbundle\-update\fR \- Update your gems to the latest available versions
.
.SH "SYNOPSIS"
-\fBbundle update\fR \fI*gems\fR [\-\-all] [\-\-group=NAME] [\-\-source=NAME] [\-\-local] [\-\-ruby] [\-\-bundler[=VERSION]] [\-\-full\-index] [\-\-jobs=JOBS] [\-\-quiet] [\-\-patch|\-\-minor|\-\-major] [\-\-redownload] [\-\-strict] [\-\-conservative]
+\fBbundle update\fR \fI*gems\fR [\-\-all] [\-\-group=NAME] [\-\-source=NAME] [\-\-local] [\-\-ruby] [\-\-bundler[=VERSION]] [\-\-full\-index] [\-\-jobs=JOBS] [\-\-quiet] [\-\-force] [\-\-patch|\-\-minor|\-\-major] [\-\-strict] [\-\-conservative]
.
.SH "DESCRIPTION"
Update the gems specified (all gems, if \fB\-\-all\fR flag is used), ignoring the previously installed gems specified in the \fBGemfile\.lock\fR\. In general, you should use bundle install(1) \fIbundle\-install\.1\.html\fR to install the same exact gems and versions across machines\.
@@ -58,8 +58,8 @@ Retry failed network or git requests for \fInumber\fR times\.
Only output warnings and errors\.
.
.TP
-\fB\-\-redownload\fR
-Force downloading every gem\.
+\fB\-\-force\fR
+Force downloading every gem\. \fB\-\-redownload\fR is an alias of this option\.
.
.TP
\fB\-\-patch\fR
diff --git a/man/bundle-update.1.txt b/man/bundle-update.1.txt
index 5738428..1a206e2 100644
--- a/man/bundle-update.1.txt
+++ b/man/bundle-update.1.txt
@@ -8,7 +8,7 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1)
1mSYNOPSIS0m
1mbundle update 4m22m*gems24m [--all] [--group=NAME] [--source=NAME] [--local]
[--ruby] [--bundler[=VERSION]] [--full-index] [--jobs=JOBS] [--quiet]
- [--patch|--minor|--major] [--redownload] [--strict] [--conservative]
+ [--force] [--patch|--minor|--major] [--strict] [--conservative]
1mDESCRIPTION0m
Update the gems specified (all gems, if 1m--all 22mflag is used), ignoring
@@ -57,8 +57,9 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1)
1m--quiet0m
Only output warnings and errors.
- 1m--redownload0m
- Force downloading every gem.
+ 1m--force0m
+ Force downloading every gem. 1m--redownload 22mis an alias of this
+ option.
1m--patch0m
Prefer updating only to next patch version.
@@ -78,8 +79,8 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1)
shared dependencies to be updated.
1mUPDATING ALL GEMS0m
- If you run 1mbundle update --all22m, bundler will ignore any previously
- installed gems and resolve all dependencies again based on the latest
+ If you run 1mbundle update --all22m, bundler will ignore any previously
+ installed gems and resolve all dependencies again based on the latest
versions of all gems available in the sources.
Consider the following Gemfile(5):
@@ -93,8 +94,8 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1)
- When you run bundle install(1) 4mbundle-install.1.html24m the first time,
- bundler will resolve all of the dependencies, all the way down, and
+ When you run bundle install(1) 4mbundle-install.1.html24m the first time,
+ bundler will resolve all of the dependencies, all the way down, and
install what you need:
@@ -133,43 +134,43 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1)
- As you can see, even though you have two gems in the Gemfile(5), your
- application needs 26 different gems in order to run. Bundler remembers
- the exact versions it installed in 1mGemfile.lock22m. The next time you run
- bundle install(1) 4mbundle-install.1.html24m, bundler skips the dependency
+ As you can see, even though you have two gems in the Gemfile(5), your
+ application needs 26 different gems in order to run. Bundler remembers
+ the exact versions it installed in 1mGemfile.lock22m. The next time you run
+ bundle install(1) 4mbundle-install.1.html24m, bundler skips the dependency
resolution and installs the same gems as it installed last time.
- After checking in the 1mGemfile.lock 22minto version control and cloning it
- on another machine, running bundle install(1) 4mbundle-install.1.html0m
- will 4mstill24m install the gems that you installed last time. You don't
+ After checking in the 1mGemfile.lock 22minto version control and cloning it
+ on another machine, running bundle install(1) 4mbundle-install.1.html0m
+ will 4mstill24m install the gems that you installed last time. You don't
need to worry that a new release of 1merubis 22mor 1mmail 22mchanges the gems you
use.
- However, from time to time, you might want to update the gems you are
- using to the newest versions that still match the gems in your Gem-
+ However, from time to time, you might want to update the gems you are
+ using to the newest versions that still match the gems in your Gem-
file(5).
- To do this, run 1mbundle update --all22m, which will ignore the 1mGem-0m
- 1mfile.lock22m, and resolve all the dependencies again. Keep in mind that
- this process can result in a significantly different set of the 25
- gems, based on the requirements of new gems that the gem authors
+ To do this, run 1mbundle update --all22m, which will ignore the 1mGem-0m
+ 1mfile.lock22m, and resolve all the dependencies again. Keep in mind that
+ this process can result in a significantly different set of the 25
+ gems, based on the requirements of new gems that the gem authors
released since the last time you ran 1mbundle update --all22m.
1mUPDATING A LIST OF GEMS0m
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
+ the rest of the gems that you specified locked to the versions in the
1mGemfile.lock22m.
- For instance, in the scenario above, imagine that 1mnokogiri 22mreleases
+ For instance, in the scenario above, imagine that 1mnokogiri 22mreleases
version 1m1.4.422m, and you want to update it 4mwithout24m updating Rails and all
of its dependencies. To do this, run 1mbundle update nokogiri22m.
- Bundler will update 1mnokogiri 22mand any of its dependencies, but leave
+ Bundler will update 1mnokogiri 22mand any of its dependencies, but leave
alone Rails and its dependencies.
1mOVERLAPPING DEPENDENCIES0m
- Sometimes, multiple gems declared in your Gemfile(5) are satisfied by
- the same second-level dependency. For instance, consider the case of
+ Sometimes, multiple gems declared in your Gemfile(5) are satisfied by
+ the same second-level dependency. For instance, consider the case of
1mthin 22mand 1mrack-perftools-profiler22m.
@@ -181,7 +182,7 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1)
- The 1mthin 22mgem depends on 1mrack >= 1.022m, while 1mrack-perftools-profiler0m
+ The 1mthin 22mgem depends on 1mrack >= 1.022m, while 1mrack-perftools-profiler0m
depends on 1mrack ~> 1.022m. If you run bundle install, you get:
@@ -199,14 +200,14 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1)
In this case, the two gems have their own set of dependencies, but they
- share 1mrack 22min common. If you run 1mbundle update thin22m, bundler will
- update 1mdaemons22m, 1meventmachine 22mand 1mrack22m, which are dependencies of 1mthin22m,
- but not 1mopen4 22mor 1mperftools.rb22m, which are dependencies of
- 1mrack-perftools_profiler22m. Note that 1mbundle update thin 22mwill update 1mrack0m
+ share 1mrack 22min common. If you run 1mbundle update thin22m, bundler will
+ update 1mdaemons22m, 1meventmachine 22mand 1mrack22m, which are dependencies of 1mthin22m,
+ but not 1mopen4 22mor 1mperftools.rb22m, which are dependencies of
+ 1mrack-perftools_profiler22m. Note that 1mbundle update thin 22mwill update 1mrack0m
even though it's 4malso24m a dependency of 1mrack-perftools_profiler22m.
- In short, by default, when you update a gem using 1mbundle update22m,
- bundler will update all dependencies of that gem, including those that
+ In short, by default, when you update a gem using 1mbundle update22m,
+ bundler will update all dependencies of that gem, including those that
are also dependencies of another gem.
To prevent updating shared dependencies, prior to version 1.14 the only
@@ -214,8 +215,8 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1)
4mdle-install.1.html24m:
In this scenario, updating the 1mthin 22mversion manually in the Gemfile(5),
- and then running bundle install(1) 4mbundle-install.1.html24m will only
- update 1mdaemons 22mand 1meventmachine22m, but not 1mrack22m. For more information,
+ and then running bundle install(1) 4mbundle-install.1.html24m will only
+ update 1mdaemons 22mand 1meventmachine22m, but not 1mrack22m. For more information,
see the 1mCONSERVATIVE UPDATING 22msection of bundle install(1) 4mbun-0m
4mdle-install.1.html24m.
@@ -223,8 +224,8 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1)
vent shared dependencies from being updated.
1mPATCH LEVEL OPTIONS0m
- Version 1.14 introduced 4 patch-level options that will influence how
- gem versions are resolved. One of the following options can be used:
+ Version 1.14 introduced 4 patch-level options that will influence how
+ gem versions are resolved. One of the following options can be used:
1m--patch22m, 1m--minor 22mor 1m--major22m. 1m--strict 22mcan be added to further influence
resolution.
@@ -241,41 +242,41 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1)
Do not allow any gem to be updated past latest 1m--patch 22m| 1m--minor0m
| 1m--major22m.
- When Bundler is resolving what versions to use to satisfy declared
- requirements in the Gemfile or in parent gems, it looks up all avail-
+ When Bundler is resolving what versions to use to satisfy declared
+ requirements in the Gemfile or in parent gems, it looks up all avail-
able versions, filters out any versions that don't satisfy the require-
ment, and then, by default, sorts them from newest to oldest, consider-
ing them in that order.
- Providing one of the patch level options (e.g. 1m--patch22m) changes the
- sort order of the satisfying versions, causing Bundler to consider the
+ Providing one of the patch level options (e.g. 1m--patch22m) changes the
+ sort order of the satisfying versions, causing Bundler to consider the
latest 1m--patch 22mor 1m--minor 22mversion available before other versions. Note
that versions outside the stated patch level could still be resolved to
if necessary to find a suitable dependency graph.
- For example, if gem 'foo' is locked at 1.0.2, with no gem requirement
- defined in the Gemfile, and versions 1.0.3, 1.0.4, 1.1.0, 1.1.1, 2.0.0
+ For example, if gem 'foo' is locked at 1.0.2, with no gem requirement
+ defined in the Gemfile, and versions 1.0.3, 1.0.4, 1.1.0, 1.1.1, 2.0.0
all exist, the default order of preference by default (1m--major22m) will be
"2.0.0, 1.1.1, 1.1.0, 1.0.4, 1.0.3, 1.0.2".
- If the 1m--patch 22moption is used, the order of preference will change to
+ If the 1m--patch 22moption is used, the order of preference will change to
"1.0.4, 1.0.3, 1.0.2, 1.1.1, 1.1.0, 2.0.0".
- If the 1m--minor 22moption is used, the order of preference will change to
+ If the 1m--minor 22moption is used, the order of preference will change to
"1.1.1, 1.1.0, 1.0.4, 1.0.3, 1.0.2, 2.0.0".
- Combining the 1m--strict 22moption with any of the patch level options will
- remove any versions beyond the scope of the patch level option, to
+ Combining the 1m--strict 22moption with any of the patch level options will
+ remove any versions beyond the scope of the patch level option, to
ensure that no gem is updated that far.
- To continue the previous example, if both 1m--patch 22mand 1m--strict 22moptions
+ To continue the previous example, if both 1m--patch 22mand 1m--strict 22moptions
are used, the available versions for resolution would be "1.0.4, 1.0.3,
- 1.0.2". If 1m--minor 22mand 1m--strict 22mare used, it would be "1.1.1, 1.1.0,
+ 1.0.2". If 1m--minor 22mand 1m--strict 22mare used, it would be "1.1.1, 1.1.0,
1.0.4, 1.0.3, 1.0.2".
- Gem requirements as defined in the Gemfile will still be the first
+ Gem requirements as defined in the Gemfile will still be the first
determining factor for what versions are available. If the gem require-
- ment for 1mfoo 22min the Gemfile is '~> 1.0', that will accomplish the same
+ ment for 1mfoo 22min the Gemfile is '~> 1.0', that will accomplish the same
thing as providing the 1m--minor 22mand 1m--strict 22moptions.
1mPATCH LEVEL EXAMPLES0m
@@ -324,26 +325,26 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1)
- In case 1, bar is upgraded to 2.1.1, a minor version increase, because
+ In case 1, bar is upgraded to 2.1.1, a minor version increase, because
the dependency from foo 1.4.5 required it.
- In case 2, only foo is requested to be unlocked, but bar is also
+ In case 2, only foo is requested to be unlocked, but bar is also
allowed to move because it's not a declared dependency in the Gemfile.
- In case 3, bar goes up a whole major release, because a minor increase
- is preferred now for foo, and when it goes to 1.5.1, it requires 3.0.0
+ In case 3, bar goes up a whole major release, because a minor increase
+ is preferred now for foo, and when it goes to 1.5.1, it requires 3.0.0
of bar.
In case 4, foo is preferred up to a minor version, but 1.5.1 won't work
- because the --strict flag removes bar 3.0.0 from consideration since
+ because the --strict flag removes bar 3.0.0 from consideration since
it's a major increment.
- In case 5, both foo and bar have any minor or major increments removed
- from consideration because of the --strict flag, so the most they can
+ In case 5, both foo and bar have any minor or major increments removed
+ from consideration because of the --strict flag, so the most they can
move is up to 1.4.4 and 2.0.4.
1mRECOMMENDED WORKFLOW0m
- In general, when working with an application managed with bundler, you
+ In general, when working with an application managed with bundler, you
should use the following workflow:
o After you create your Gemfile(5) for the first time, run
@@ -354,7 +355,7 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1)
$ git add Gemfile.lock
- o When checking out this repository on another development machine,
+ o When checking out this repository on another development machine,
run
$ bundle install
@@ -363,7 +364,7 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1)
$ bundle install --deployment
- o After changing the Gemfile(5) to reflect a new or update depen-
+ o After changing the Gemfile(5) to reflect a new or update depen-
dency, run
$ bundle install
@@ -377,7 +378,7 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1)
$ bundle update rails thin
- o If you want to update all the gems to the latest possible versions
+ o If you want to update all the gems to the latest possible versions
that still match the gems listed in the Gemfile(5), run
$ bundle update --all
@@ -387,4 +388,4 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1)
- November 2018 BUNDLE-UPDATE(1)
+ December 2018 BUNDLE-UPDATE(1)