diff options
| author | hsbt <hsbt@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2018-11-02 23:07:56 +0000 |
|---|---|---|
| committer | hsbt <hsbt@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2018-11-02 23:07:56 +0000 |
| commit | 59c8d50653480bef3f24517296e6ddf937fdf6bc (patch) | |
| tree | df10aaf4f3307837fe3d1d129d66f6c0c7586bc5 /man | |
| parent | 7deb37777a230837e865e0a11fb8d7c1dc6d03ce (diff) | |
| download | ruby-59c8d50653480bef3f24517296e6ddf937fdf6bc.tar.gz | |
Added bundler as default gems. Revisit [Feature #12733]
* bin/*, lib/bundler/*, lib/bundler.rb, spec/bundler, man/*:
Merge from latest stable branch of bundler/bundler repository and
added workaround patches. I will backport them into upstream.
* common.mk, defs/gmake.mk: Added `test-bundler` task for test suite
of bundler.
* tool/sync_default_gems.rb: Added sync task for bundler.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@65509 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'man')
75 files changed, 8987 insertions, 0 deletions
diff --git a/man/bundle-add.1 b/man/bundle-add.1 new file mode 100644 index 0000000000..c8b5bcec70 --- /dev/null +++ b/man/bundle-add.1 @@ -0,0 +1,58 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BUNDLE\-ADD" "1" "October 2018" "" "" +. +.SH "NAME" +\fBbundle\-add\fR \- Add gem to the Gemfile and run bundle install +. +.SH "SYNOPSIS" +\fBbundle add\fR \fIGEM_NAME\fR [\-\-group=GROUP] [\-\-version=VERSION] [\-\-source=SOURCE] [\-\-skip\-install] [\-\-strict] [\-\-optimistic] +. +.SH "DESCRIPTION" +Adds the named gem to the Gemfile and run \fBbundle install\fR\. \fBbundle install\fR can be avoided by using the flag \fB\-\-skip\-install\fR\. +. +.P +Example: +. +.P +bundle add rails +. +.P +bundle add rails \-\-version "< 3\.0, > 1\.1" +. +.P +bundle add rails \-\-version "~> 5\.0\.0" \-\-source "https://gems\.example\.com" \-\-group "development" +. +.P +bundle add rails \-\-skip\-install +. +.P +bundle add rails \-\-group "development, test" +. +.SH "OPTIONS" +. +.TP +\fB\-\-version\fR, \fB\-v\fR +Specify version requirements(s) for the added gem\. +. +.TP +\fB\-\-group\fR, \fB\-g\fR +Specify the group(s) for the added gem\. Multiple groups should be separated by commas\. +. +.TP +\fB\-\-source\fR, , \fB\-s\fR +Specify the source for the added gem\. +. +.TP +\fB\-\-skip\-install\fR +Adds the gem to the Gemfile but does not install it\. +. +.TP +\fB\-\-optimistic\fR +Adds optimistic declaration of version +. +.TP +\fB\-\-strict\fR +Adds strict declaration of version + diff --git a/man/bundle-add.1.txt b/man/bundle-add.1.txt new file mode 100644 index 0000000000..eda61e2dd5 --- /dev/null +++ b/man/bundle-add.1.txt @@ -0,0 +1,52 @@ +BUNDLE-ADD(1) BUNDLE-ADD(1) + + + +1mNAME0m + 1mbundle-add 22m- Add gem to the Gemfile and run bundle install + +1mSYNOPSIS0m + 1mbundle add 4m22mGEM_NAME24m [--group=GROUP] [--version=VERSION] + [--source=SOURCE] [--skip-install] [--strict] [--optimistic] + +1mDESCRIPTION0m + Adds the named gem to the Gemfile and run 1mbundle install22m. 1mbundle0m + 1minstall 22mcan be avoided by using the flag 1m--skip-install22m. + + Example: + + bundle add rails + + bundle add rails --version "< 3.0, > 1.1" + + bundle add rails --version "~> 5.0.0" --source "https://gems.exam- + ple.com" --group "development" + + bundle add rails --skip-install + + bundle add rails --group "development, test" + +1mOPTIONS0m + 1m--version22m, 1m-v0m + Specify version requirements(s) for the added gem. + + 1m--group22m, 1m-g0m + Specify the group(s) for the added gem. Multiple groups should + be separated by commas. + + 1m--source22m, , 1m-s0m + Specify the source for the added gem. + + 1m--skip-install0m + Adds the gem to the Gemfile but does not install it. + + 1m--optimistic0m + Adds optimistic declaration of version + + 1m--strict0m + Adds strict declaration of version + + + + + October 2018 BUNDLE-ADD(1) diff --git a/man/bundle-add.ronn b/man/bundle-add.ronn new file mode 100644 index 0000000000..1e2d732ec6 --- /dev/null +++ b/man/bundle-add.ronn @@ -0,0 +1,40 @@ +bundle-add(1) -- Add gem to the Gemfile and run bundle install +================================================================ + +## SYNOPSIS + +`bundle add` <GEM_NAME> [--group=GROUP] [--version=VERSION] [--source=SOURCE] [--skip-install] [--strict] [--optimistic] + +## DESCRIPTION +Adds the named gem to the Gemfile and run `bundle install`. `bundle install` can be avoided by using the flag `--skip-install`. + +Example: + +bundle add rails + +bundle add rails --version "< 3.0, > 1.1" + +bundle add rails --version "~> 5.0.0" --source "https://gems.example.com" --group "development" + +bundle add rails --skip-install + +bundle add rails --group "development, test" + +## OPTIONS +* `--version`, `-v`: + Specify version requirements(s) for the added gem. + +* `--group`, `-g`: + Specify the group(s) for the added gem. Multiple groups should be separated by commas. + +* `--source`, , `-s`: + Specify the source for the added gem. + +* `--skip-install`: + Adds the gem to the Gemfile but does not install it. + +* `--optimistic`: + Adds optimistic declaration of version + +* `--strict`: + Adds strict declaration of version diff --git a/man/bundle-binstubs.1 b/man/bundle-binstubs.1 new file mode 100644 index 0000000000..9757abb570 --- /dev/null +++ b/man/bundle-binstubs.1 @@ -0,0 +1,40 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BUNDLE\-BINSTUBS" "1" "October 2018" "" "" +. +.SH "NAME" +\fBbundle\-binstubs\fR \- Install the binstubs of the listed gems +. +.SH "SYNOPSIS" +\fBbundle binstubs\fR \fIGEM_NAME\fR [\-\-force] [\-\-path PATH] [\-\-standalone] +. +.SH "DESCRIPTION" +Binstubs are scripts that wrap around executables\. Bundler creates a small Ruby file (a binstub) that loads Bundler, runs the command, and puts it into \fBbin/\fR\. Binstubs are a shortcut\-or alternative\- to always using \fBbundle exec\fR\. This gives you a file that can by run directly, and one that will always run the correct gem version used by the application\. +. +.P +For example, if you run \fBbundle binstubs rspec\-core\fR, Bundler will create the file \fBbin/rspec\fR\. That file will contain enough code to load Bundler, tell it to load the bundled gems, and then run rspec\. +. +.P +This command generates binstubs for executables in \fBGEM_NAME\fR\. Binstubs are put into \fBbin\fR, or the \fB\-\-path\fR directory if one has been set\. Calling binstubs with [GEM [GEM]] will create binstubs for all given gems\. +. +.SH "OPTIONS" +. +.TP +\fB\-\-force\fR +Overwrite existing binstubs if they exist\. +. +.TP +\fB\-\-path\fR +The location to install the specified binstubs to\. This defaults to \fBbin\fR\. +. +.TP +\fB\-\-standalone\fR +Makes binstubs that can work without depending on Rubygems or Bundler at runtime\. +. +.TP +\fB\-\-shebang\fR +Specify a different shebang executable name than the default (default \'ruby\') +. +.SH "BUNDLE INSTALL \-\-BINSTUBS" +To create binstubs for all the gems in the bundle you can use the \fB\-\-binstubs\fR flag in bundle install(1) \fIbundle\-install\.1\.html\fR\. diff --git a/man/bundle-binstubs.1.txt b/man/bundle-binstubs.1.txt new file mode 100644 index 0000000000..adc0a1304f --- /dev/null +++ b/man/bundle-binstubs.1.txt @@ -0,0 +1,48 @@ +BUNDLE-BINSTUBS(1) BUNDLE-BINSTUBS(1) + + + +1mNAME0m + 1mbundle-binstubs 22m- Install the binstubs of the listed gems + +1mSYNOPSIS0m + 1mbundle binstubs 4m22mGEM_NAME24m [--force] [--path PATH] [--standalone] + +1mDESCRIPTION0m + Binstubs are scripts that wrap around executables. Bundler creates a + small Ruby file (a binstub) that loads Bundler, runs the command, and + puts it into 1mbin/22m. Binstubs are a shortcut-or alternative- to always + using 1mbundle exec22m. This gives you a file that can by run directly, and + one that will always run the correct gem version used by the applica- + tion. + + For example, if you run 1mbundle binstubs rspec-core22m, Bundler will create + the file 1mbin/rspec22m. That file will contain enough code to load Bundler, + tell it to load the bundled gems, and then run rspec. + + This command generates binstubs for executables in 1mGEM_NAME22m. Binstubs + are put into 1mbin22m, or the 1m--path 22mdirectory if one has been set. Calling + binstubs with [GEM [GEM]] will create binstubs for all given gems. + +1mOPTIONS0m + 1m--force0m + Overwrite existing binstubs if they exist. + + 1m--path 22mThe location to install the specified binstubs to. This defaults + to 1mbin22m. + + 1m--standalone0m + Makes binstubs that can work without depending on Rubygems or + Bundler at runtime. + + 1m--shebang0m + Specify a different shebang executable name than the default + (default 'ruby') + +1mBUNDLE INSTALL --BINSTUBS0m + To create binstubs for all the gems in the bundle you can use the + 1m--binstubs 22mflag in bundle install(1) 4mbundle-install.1.html24m. + + + + October 2018 BUNDLE-BINSTUBS(1) diff --git a/man/bundle-binstubs.ronn b/man/bundle-binstubs.ronn new file mode 100644 index 0000000000..c1ae0988cd --- /dev/null +++ b/man/bundle-binstubs.ronn @@ -0,0 +1,43 @@ +bundle-binstubs(1) -- Install the binstubs of the listed gems +============================================================= + +## SYNOPSIS + +`bundle binstubs` <GEM_NAME> [--force] [--path PATH] [--standalone] + +## DESCRIPTION + +Binstubs are scripts that wrap around executables. Bundler creates a +small Ruby file (a binstub) that loads Bundler, runs the command, +and puts it into `bin/`. Binstubs are a shortcut-or alternative- +to always using `bundle exec`. This gives you a file that can by run +directly, and one that will always run the correct gem version +used by the application. + +For example, if you run `bundle binstubs rspec-core`, Bundler will create +the file `bin/rspec`. That file will contain enough code to load Bundler, +tell it to load the bundled gems, and then run rspec. + +This command generates binstubs for executables in `GEM_NAME`. +Binstubs are put into `bin`, or the `--path` directory if one has been set. +Calling binstubs with [GEM [GEM]] will create binstubs for all given gems. + +## OPTIONS + +* `--force`: + Overwrite existing binstubs if they exist. + +* `--path`: + The location to install the specified binstubs to. This defaults to `bin`. + +* `--standalone`: + Makes binstubs that can work without depending on Rubygems or Bundler at + runtime. + +* `--shebang`: + Specify a different shebang executable name than the default (default 'ruby') + +## BUNDLE INSTALL --BINSTUBS + +To create binstubs for all the gems in the bundle you can use the `--binstubs` +flag in [bundle install(1)](bundle-install.1.html). diff --git a/man/bundle-check.1 b/man/bundle-check.1 new file mode 100644 index 0000000000..a68b9cc4af --- /dev/null +++ b/man/bundle-check.1 @@ -0,0 +1,31 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BUNDLE\-CHECK" "1" "June 2018" "" "" +. +.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\. +. +.SH "OPTIONS" +. +.TP +\fB\-\-dry\-run\fR +Locks the [\fBGemfile(5)\fR][Gemfile(5)] before running the command\. +. +.TP +\fB\-\-gemfile\fR +Use the specified gemfile instead of the [\fBGemfile(5)\fR][Gemfile(5)]\. +. +.TP +\fB\-\-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\. + diff --git a/man/bundle-check.1.txt b/man/bundle-check.1.txt new file mode 100644 index 0000000000..dc02055003 --- /dev/null +++ b/man/bundle-check.1.txt @@ -0,0 +1,33 @@ +BUNDLE-CHECK(1) BUNDLE-CHECK(1) + + + +1mNAME0m + 1mbundle-check 22m- Verifies if dependencies are satisfied by installed gems + +1mSYNOPSIS0m + 1mbundle check 22m[--dry-run] [--gemfile=FILE] [--path=PATH] + +1mDESCRIPTION0m + 1mcheck 22msearches 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. + + If not, the first missing gem is listed and Bundler exits status 1. + +1mOPTIONS0m + 1m--dry-run0m + Locks the [1mGemfile(5)22m][Gemfile(5)] before running the command. + + 1m--gemfile0m + Use the specified gemfile instead of the [1mGemfile(5)22m][Gem- + file(5)]. + + 1m--path 22mSpecify a different path than the system default (1m$BUNDLE_PATH0m + or 1m$GEM_HOME22m). Bundler will remember this value for future + installs on this machine. + + + + + June 2018 BUNDLE-CHECK(1) diff --git a/man/bundle-check.ronn b/man/bundle-check.ronn new file mode 100644 index 0000000000..f2846b8ff2 --- /dev/null +++ b/man/bundle-check.ronn @@ -0,0 +1,26 @@ +bundle-check(1) -- Verifies if dependencies are satisfied by installed gems +=========================================================================== + +## SYNOPSIS + +`bundle check` [--dry-run] + [--gemfile=FILE] + [--path=PATH] + +## DESCRIPTION + +`check` 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. + +If not, the first missing gem is listed and Bundler exits status 1. + +## OPTIONS + +* `--dry-run`: + Locks the [`Gemfile(5)`][Gemfile(5)] before running the command. +* `--gemfile`: + Use the specified gemfile instead of the [`Gemfile(5)`][Gemfile(5)]. +* `--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. diff --git a/man/bundle-clean.1 b/man/bundle-clean.1 new file mode 100644 index 0000000000..7c4985cb80 --- /dev/null +++ b/man/bundle-clean.1 @@ -0,0 +1,24 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BUNDLE\-CLEAN" "1" "May 2018" "" "" +. +.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\. + diff --git a/man/bundle-clean.1.txt b/man/bundle-clean.1.txt new file mode 100644 index 0000000000..dd5e1f32e3 --- /dev/null +++ b/man/bundle-clean.1.txt @@ -0,0 +1,26 @@ +BUNDLE-CLEAN(1) BUNDLE-CLEAN(1) + + + +1mNAME0m + 1mbundle-clean 22m- Cleans up unused gems in your bundler directory + +1mSYNOPSIS0m + 1mbundle clean 22m[--dry-run] [--force] + +1mDESCRIPTION0m + This command will remove all unused gems in your bundler directory. + This is useful when you have made many changes to your gem dependen- + cies. + +1mOPTIONS0m + 1m--dry-run0m + Print the changes, but do not clean the unused gems. + + 1m--force0m + Force a clean even if 1m--path 22mis not set. + + + + + May 2018 BUNDLE-CLEAN(1) diff --git a/man/bundle-clean.ronn b/man/bundle-clean.ronn new file mode 100644 index 0000000000..de23991782 --- /dev/null +++ b/man/bundle-clean.ronn @@ -0,0 +1,18 @@ +bundle-clean(1) -- Cleans up unused gems in your bundler directory +================================================================== + +## SYNOPSIS + +`bundle clean` [--dry-run] [--force] + +## 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. + +## OPTIONS + +* `--dry-run`: + Print the changes, but do not clean the unused gems. +* `--force`: + Force a clean even if `--path` is not set. diff --git a/man/bundle-config.1 b/man/bundle-config.1 new file mode 100644 index 0000000000..c250975a6c --- /dev/null +++ b/man/bundle-config.1 @@ -0,0 +1,481 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BUNDLE\-CONFIG" "1" "October 2018" "" "" +. +.SH "NAME" +\fBbundle\-config\fR \- Set bundler configuration options +. +.SH "SYNOPSIS" +\fBbundle config\fR [\fIname\fR [\fIvalue\fR]] +. +.SH "DESCRIPTION" +This command allows you to interact with Bundler\'s configuration system\. +. +.P +Bundler loads configuration settings in this order: +. +.IP "1." 4 +Local config (\fBapp/\.bundle/config\fR) +. +.IP "2." 4 +Environmental variables (\fBENV\fR) +. +.IP "3." 4 +Global config (\fB~/\.bundle/config\fR) +. +.IP "4." 4 +Bundler default config +. +.IP "" 0 +. +.P +Executing \fBbundle config\fR with no parameters will print a list of all bundler configuration for the current bundle, and where that configuration was set\. +. +.P +Executing \fBbundle config <name>\fR will print the value of that configuration setting, and where it was set\. +. +.P +Executing \fBbundle config <name> <value>\fR will set that configuration to the value specified for all bundles executed as the current user\. The configuration will be stored in \fB~/\.bundle/config\fR\. If \fIname\fR already is set, \fIname\fR will be overridden and user will be warned\. +. +.P +Executing \fBbundle config \-\-global <name> <value>\fR works the same as above\. +. +.P +Executing \fBbundle config \-\-local <name> <value>\fR will set that configuration to the local application\. The configuration will be stored in \fBapp/\.bundle/config\fR\. +. +.P +Executing \fBbundle config \-\-delete <name>\fR will delete the configuration in both local and global sources\. Not compatible with \-\-global or \-\-local flag\. +. +.P +Executing bundle with the \fBBUNDLE_IGNORE_CONFIG\fR environment variable set will cause it to ignore all configuration\. +. +.P +Executing \fBbundle config disable_multisource true\fR upgrades the warning about the Gemfile containing multiple primary sources to an error\. Executing \fBbundle config \-\-delete disable_multisource\fR downgrades this error to a warning\. +. +.SH "REMEMBERING OPTIONS" +Flags passed to \fBbundle install\fR or the Bundler runtime, such as \fB\-\-path foo\fR or \fB\-\-without production\fR, are not remembered between commands\. If these options must be remembered,they must be set using \fBbundle config\fR (e\.g\., \fBbundle config path foo\fR)\. +. +.P +The options that can be configured are: +. +.TP +\fBbin\fR +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 +\fBdeployment\fR +In deployment mode, Bundler will \'roll\-out\' the bundle for \fBproduction\fR use\. Please check carefully if you want to have this option enabled in \fBdevelopment\fR or \fBtest\fR environments\. +. +.TP +\fBpath\fR +The location to install the specified gems to\. This defaults to Rubygems\' setting\. Bundler shares this location with Rubygems, \fBgem install \.\.\.\fR will have gem installed there, too\. Therefore, gems installed without a \fB\-\-path \.\.\.\fR setting will show up by calling \fBgem list\fR\. Accordingly, gems installed to other locations will not get listed\. +. +.TP +\fBwithout\fR +A space\-separated list of groups referencing gems to skip during installation\. +. +.TP +\fBwith\fR +A space\-separated list of groups referencing gems to include during installation\. +. +.SH "BUILD OPTIONS" +You can use \fBbundle config\fR to give Bundler the flags to pass to the gem installer every time bundler tries to install a particular gem\. +. +.P +A very common example, the \fBmysql\fR gem, requires Snow Leopard users to pass configuration flags to \fBgem install\fR to specify where to find the \fBmysql_config\fR executable\. +. +.IP "" 4 +. +.nf + +gem install mysql \-\- \-\-with\-mysql\-config=/usr/local/mysql/bin/mysql_config +. +.fi +. +.IP "" 0 +. +.P +Since the specific location of that executable can change from machine to machine, you can specify these flags on a per\-machine basis\. +. +.IP "" 4 +. +.nf + +bundle config build\.mysql \-\-with\-mysql\-config=/usr/local/mysql/bin/mysql_config +. +.fi +. +.IP "" 0 +. +.P +After running this command, every time bundler needs to install the \fBmysql\fR gem, it will pass along the flags you specified\. +. +.SH "CONFIGURATION KEYS" +Configuration keys in bundler have two forms: the canonical form and the environment variable form\. +. +.P +For instance, passing the \fB\-\-without\fR flag to bundle install(1) \fIbundle\-install\.1\.html\fR prevents Bundler from installing certain groups specified in the Gemfile(5)\. Bundler persists this value in \fBapp/\.bundle/config\fR so that calls to \fBBundler\.setup\fR do not try to find gems from the \fBGemfile\fR that you didn\'t install\. Additionally, subsequent calls to bundle install(1) \fIbundle\-install\.1\.html\fR remember this setting and skip those groups\. +. +.P +The canonical form of this configuration is \fB"without"\fR\. To convert the canonical form to the environment variable form, capitalize it, and prepend \fBBUNDLE_\fR\. The environment variable form of \fB"without"\fR is \fBBUNDLE_WITHOUT\fR\. +. +.P +Any periods in the configuration keys must be replaced with two underscores when setting it via environment variables\. The configuration key \fBlocal\.rack\fR becomes the environment variable \fBBUNDLE_LOCAL__RACK\fR\. +. +.SH "LIST OF AVAILABLE KEYS" +The following is a list of all configuration keys and their purpose\. You can learn more about their operation in bundle install(1) \fIbundle\-install\.1\.html\fR\. +. +.IP "\(bu" 4 +\fBallow_bundler_dependency_conflicts\fR (\fBBUNDLE_ALLOW_BUNDLER_DEPENDENCY_CONFLICTS\fR): Allow resolving to specifications that have dependencies on \fBbundler\fR that are incompatible with the running Bundler version\. +. +.IP "\(bu" 4 +\fBallow_deployment_source_credential_changes\fR (\fBBUNDLE_ALLOW_DEPLOYMENT_SOURCE_CREDENTIAL_CHANGES\fR): When in deployment mode, allow changing the credentials to a gem\'s source\. Ex: \fBhttps://some\.host\.com/gems/path/\fR \-> \fBhttps://user_name:password@some\.host\.com/gems/path\fR +. +.IP "\(bu" 4 +\fBallow_offline_install\fR (\fBBUNDLE_ALLOW_OFFLINE_INSTALL\fR): Allow Bundler to use cached data when installing without network access\. +. +.IP "\(bu" 4 +\fBauto_clean_without_path\fR (\fBBUNDLE_AUTO_CLEAN_WITHOUT_PATH\fR): Automatically run \fBbundle clean\fR after installing when an explicit \fBpath\fR has not been set and Bundler is not installing into the system gems\. +. +.IP "\(bu" 4 +\fBauto_install\fR (\fBBUNDLE_AUTO_INSTALL\fR): Automatically run \fBbundle install\fR when gems are missing\. +. +.IP "\(bu" 4 +\fBbin\fR (\fBBUNDLE_BIN\fR): Install executables from gems in the bundle to the specified directory\. Defaults to \fBfalse\fR\. +. +.IP "\(bu" 4 +\fBcache_all\fR (\fBBUNDLE_CACHE_ALL\fR): Cache all gems, including path and git gems\. +. +.IP "\(bu" 4 +\fBcache_all_platforms\fR (\fBBUNDLE_CACHE_ALL_PLATFORMS\fR): Cache gems for all platforms\. +. +.IP "\(bu" 4 +\fBcache_path\fR (\fBBUNDLE_CACHE_PATH\fR): The directory that bundler will place cached gems in when running \fBbundle package\fR, and that bundler will look in when installing gems\. Defaults to \fBvendor/bundle\fR\. +. +.IP "\(bu" 4 +\fBclean\fR (\fBBUNDLE_CLEAN\fR): Whether Bundler should run \fBbundle clean\fR automatically after \fBbundle install\fR\. +. +.IP "\(bu" 4 +\fBconsole\fR (\fBBUNDLE_CONSOLE\fR): The console that \fBbundle console\fR starts\. Defaults to \fBirb\fR\. +. +.IP "\(bu" 4 +\fBdefault_install_uses_path\fR (\fBBUNDLE_DEFAULT_INSTALL_USES_PATH\fR): Whether a \fBbundle install\fR without an explicit \fB\-\-path\fR argument defaults to installing gems in \fB\.bundle\fR\. +. +.IP "\(bu" 4 +\fBdeployment\fR (\fBBUNDLE_DEPLOYMENT\fR): Disallow changes to the \fBGemfile\fR\. When the \fBGemfile\fR is changed and the lockfile has not been updated, running Bundler commands will be blocked\. +. +.IP "\(bu" 4 +\fBdisable_checksum_validation\fR (\fBBUNDLE_DISABLE_CHECKSUM_VALIDATION\fR): Allow installing gems even if they do not match the checksum provided by RubyGems\. +. +.IP "\(bu" 4 +\fBdisable_exec_load\fR (\fBBUNDLE_DISABLE_EXEC_LOAD\fR): Stop Bundler from using \fBload\fR to launch an executable in\-process in \fBbundle exec\fR\. +. +.IP "\(bu" 4 +\fBdisable_local_branch_check\fR (\fBBUNDLE_DISABLE_LOCAL_BRANCH_CHECK\fR): Allow Bundler to use a local git override without a branch specified in the Gemfile\. +. +.IP "\(bu" 4 +\fBdisable_multisource\fR (\fBBUNDLE_DISABLE_MULTISOURCE\fR): When set, Gemfiles containing multiple sources will produce errors instead of warnings\. Use \fBbundle config \-\-delete disable_multisource\fR to unset\. +. +.IP "\(bu" 4 +\fBdisable_platform_warnings\fR (\fBBUNDLE_DISABLE_PLATFORM_WARNINGS\fR): Disable warnings during bundle install when a dependency is unused on the current platform\. +. +.IP "\(bu" 4 +\fBdisable_shared_gems\fR (\fBBUNDLE_DISABLE_SHARED_GEMS\fR): Stop Bundler from accessing gems installed to RubyGems\' normal location\. +. +.IP "\(bu" 4 +\fBdisable_version_check\fR (\fBBUNDLE_DISABLE_VERSION_CHECK\fR): Stop Bundler from checking if a newer Bundler version is available on rubygems\.org\. +. +.IP "\(bu" 4 +\fBerror_on_stderr\fR (\fBBUNDLE_ERROR_ON_STDERR\fR): Print Bundler errors to stderr\. +. +.IP "\(bu" 4 +\fBforce_ruby_platform\fR (\fBBUNDLE_FORCE_RUBY_PLATFORM\fR): Ignore the current machine\'s platform and install only \fBruby\fR platform gems\. As a result, gems with native extensions will be compiled from source\. +. +.IP "\(bu" 4 +\fBfrozen\fR (\fBBUNDLE_FROZEN\fR): Disallow changes to the \fBGemfile\fR\. When the \fBGemfile\fR is changed and the lockfile has not been updated, running Bundler commands will be blocked\. Defaults to \fBtrue\fR when \fB\-\-deployment\fR is used\. +. +.IP "\(bu" 4 +\fBgem\.push_key\fR (\fBBUNDLE_GEM__PUSH_KEY\fR): Sets the \fB\-\-key\fR parameter for \fBgem push\fR when using the \fBrake release\fR command with a private gemstash server\. +. +.IP "\(bu" 4 +\fBgemfile\fR (\fBBUNDLE_GEMFILE\fR): The name of the file that bundler should use as the \fBGemfile\fR\. This location of this file also sets the root of the project, which is used to resolve relative paths in the \fBGemfile\fR, among other things\. By default, bundler will search up from the current working directory until it finds a \fBGemfile\fR\. +. +.IP "\(bu" 4 +\fBglobal_gem_cache\fR (\fBBUNDLE_GLOBAL_GEM_CACHE\fR): Whether Bundler should cache all gems globally, rather than locally to the installing Ruby installation\. +. +.IP "\(bu" 4 +\fBglobal_path_appends_ruby_scope\fR (\fBBUNDLE_GLOBAL_PATH_APPENDS_RUBY_SCOPE\fR): Whether Bundler should append the Ruby scope (e\.g\. engine and ABI version) to a globally\-configured path\. +. +.IP "\(bu" 4 +\fBignore_messages\fR (\fBBUNDLE_IGNORE_MESSAGES\fR): When set, no post install messages will be printed\. To silence a single gem, use dot notation like \fBignore_messages\.httparty true\fR\. +. +.IP "\(bu" 4 +\fBinit_gems_rb\fR (\fBBUNDLE_INIT_GEMS_RB\fR) Generate a \fBgems\.rb\fR instead of a \fBGemfile\fR when running \fBbundle init\fR\. +. +.IP "\(bu" 4 +\fBjobs\fR (\fBBUNDLE_JOBS\fR): The number of gems Bundler can install in parallel\. Defaults to 1\. +. +.IP "\(bu" 4 +\fBlist_command\fR (\fBBUNDLE_LIST_COMMAND\fR) Enable new list command feature +. +.IP "\(bu" 4 +\fBmajor_deprecations\fR (\fBBUNDLE_MAJOR_DEPRECATIONS\fR): Whether Bundler should print deprecation warnings for behavior that will be changed in the next major version\. +. +.IP "\(bu" 4 +\fBno_install\fR (\fBBUNDLE_NO_INSTALL\fR): Whether \fBbundle package\fR should skip installing gems\. +. +.IP "\(bu" 4 +\fBno_prune\fR (\fBBUNDLE_NO_PRUNE\fR): Whether Bundler should leave outdated gems unpruned when caching\. +. +.IP "\(bu" 4 +\fBonly_update_to_newer_versions\fR (\fBBUNDLE_ONLY_UPDATE_TO_NEWER_VERSIONS\fR): During \fBbundle update\fR, only resolve to newer versions of the gems in the lockfile\. +. +.IP "\(bu" 4 +\fBpath\fR (\fBBUNDLE_PATH\fR): The location on disk where all gems in your bundle will be located regardless of \fB$GEM_HOME\fR or \fB$GEM_PATH\fR values\. Bundle gems not found in this location will be installed by \fBbundle install\fR\. Defaults to \fBGem\.dir\fR\. When \-\-deployment is used, defaults to vendor/bundle\. +. +.IP "\(bu" 4 +\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 (\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\. +. +.IP "\(bu" 4 +\fBprefer_gems_rb\fR (\fBBUNDLE_PREFER_GEMS_RB\fR) Prefer \fBgems\.rb\fR to \fBGemfile\fR when Bundler is searching for a Gemfile\. +. +.IP "\(bu" 4 +\fBprint_only_version_number\fR (\fBBUNDLE_PRINT_ONLY_VERSION_NUMBER\fR) Print only version number from \fBbundler \-\-version\fR\. +. +.IP "\(bu" 4 +\fBredirect\fR (\fBBUNDLE_REDIRECT\fR): The number of redirects allowed for network requests\. Defaults to \fB5\fR\. +. +.IP "\(bu" 4 +\fBretry\fR (\fBBUNDLE_RETRY\fR): The number of times to retry failed network requests\. Defaults to \fB3\fR\. +. +.IP "\(bu" 4 +\fBsetup_makes_kernel_gem_public\fR (\fBBUNDLE_SETUP_MAKES_KERNEL_GEM_PUBLIC\fR): Have \fBBundler\.setup\fR make the \fBKernel#gem\fR method public, even though RubyGems declares it as private\. +. +.IP "\(bu" 4 +\fBshebang\fR (\fBBUNDLE_SHEBANG\fR): The program name that should be invoked for generated binstubs\. Defaults to the ruby install name used to generate the binstub\. +. +.IP "\(bu" 4 +\fBsilence_root_warning\fR (\fBBUNDLE_SILENCE_ROOT_WARNING\fR): Silence the warning Bundler prints when installing gems as root\. +. +.IP "\(bu" 4 +\fBskip_default_git_sources\fR (\fBBUNDLE_SKIP_DEFAULT_GIT_SOURCES\fR): Whether Bundler should skip adding default git source shortcuts to the Gemfile DSL\. +. +.IP "\(bu" 4 +\fBspecific_platform\fR (\fBBUNDLE_SPECIFIC_PLATFORM\fR): Allow bundler to resolve for the specific running platform and store it in the lockfile, instead of only using a generic platform\. A specific platform is the exact platform triple reported by \fBGem::Platform\.local\fR, such as \fBx86_64\-darwin\-16\fR or \fBuniversal\-java\-1\.8\fR\. On the other hand, generic platforms are those such as \fBruby\fR, \fBmswin\fR, or \fBjava\fR\. In this example, \fBx86_64\-darwin\-16\fR would map to \fBruby\fR and \fBuniversal\-java\-1\.8\fR to \fBjava\fR\. +. +.IP "\(bu" 4 +\fBssl_ca_cert\fR (\fBBUNDLE_SSL_CA_CERT\fR): Path to a designated CA certificate file or folder containing multiple certificates for trusted CAs in PEM format\. +. +.IP "\(bu" 4 +\fBssl_client_cert\fR (\fBBUNDLE_SSL_CLIENT_CERT\fR): Path to a designated file containing a X\.509 client certificate and key in PEM format\. +. +.IP "\(bu" 4 +\fBssl_verify_mode\fR (\fBBUNDLE_SSL_VERIFY_MODE\fR): The SSL verification mode Bundler uses when making HTTPS requests\. Defaults to verify peer\. +. +.IP "\(bu" 4 +\fBsuppress_install_using_messages\fR (\fBBUNDLE_SUPPRESS_INSTALL_USING_MESSAGES\fR): Avoid printing \fBUsing \.\.\.\fR messages during installation when the version of a gem has not changed\. +. +.IP "\(bu" 4 +\fBsystem_bindir\fR (\fBBUNDLE_SYSTEM_BINDIR\fR): The location where RubyGems installs binstubs\. Defaults to \fBGem\.bindir\fR\. +. +.IP "\(bu" 4 +\fBtimeout\fR (\fBBUNDLE_TIMEOUT\fR): The seconds allowed before timing out for network requests\. Defaults to \fB10\fR\. +. +.IP "\(bu" 4 +\fBunlock_source_unlocks_spec\fR (\fBBUNDLE_UNLOCK_SOURCE_UNLOCKS_SPEC\fR): Whether running \fBbundle update \-\-source NAME\fR unlocks a gem with the given name\. Defaults to \fBtrue\fR\. +. +.IP "\(bu" 4 +\fBupdate_requires_all_flag\fR (\fBBUNDLE_UPDATE_REQUIRES_ALL_FLAG\fR) Require passing \fB\-\-all\fR to \fBbundle update\fR when everything should be updated, and disallow passing no options to \fBbundle update\fR\. +. +.IP "\(bu" 4 +\fBuser_agent\fR (\fBBUNDLE_USER_AGENT\fR): The custom user agent fragment Bundler includes in API requests\. +. +.IP "\(bu" 4 +\fBwith\fR (\fBBUNDLE_WITH\fR): A \fB:\fR\-separated list of groups whose gems bundler should install\. +. +.IP "\(bu" 4 +\fBwithout\fR (\fBBUNDLE_WITHOUT\fR): A \fB:\fR\-separated list of groups whose gems bundler should not install\. +. +.IP "" 0 +. +.P +In general, you should set these settings per\-application by using the applicable flag to the bundle install(1) \fIbundle\-install\.1\.html\fR or bundle package(1) \fIbundle\-package\.1\.html\fR command\. +. +.P +You can set them globally either via environment variables or \fBbundle config\fR, whichever is preferable for your setup\. If you use both, environment variables will take preference over global settings\. +. +.SH "LOCAL GIT REPOS" +Bundler also allows you to work against a git repository locally instead of using the remote version\. This can be achieved by setting up a local override: +. +.IP "" 4 +. +.nf + +bundle config local\.GEM_NAME /path/to/local/git/repository +. +.fi +. +.IP "" 0 +. +.P +For example, in order to use a local Rack repository, a developer could call: +. +.IP "" 4 +. +.nf + +bundle config local\.rack ~/Work/git/rack +. +.fi +. +.IP "" 0 +. +.P +Now instead of checking out the remote git repository, the local override will be used\. Similar to a path source, every time the local git repository change, changes will be automatically picked up by Bundler\. This means a commit in the local git repo will update the revision in the \fBGemfile\.lock\fR to the local git repo revision\. This requires the same attention as git submodules\. Before pushing to the remote, you need to ensure the local override was pushed, otherwise you may point to a commit that only exists in your local machine\. You\'ll also need to CGI escape your usernames and passwords as well\. +. +.P +Bundler does many checks to ensure a developer won\'t work with invalid references\. Particularly, we force a developer to specify a branch in the \fBGemfile\fR in order to use this feature\. If the branch specified in the \fBGemfile\fR and the current branch in the local git repository do not match, Bundler will abort\. This ensures that a developer is always working against the correct branches, and prevents accidental locking to a different branch\. +. +.P +Finally, Bundler also ensures that the current revision in the \fBGemfile\.lock\fR exists in the local git repository\. By doing this, Bundler forces you to fetch the latest changes in the remotes\. +. +.SH "MIRRORS OF GEM SOURCES" +Bundler supports overriding gem sources with mirrors\. This allows you to configure rubygems\.org as the gem source in your Gemfile while still using your mirror to fetch gems\. +. +.IP "" 4 +. +.nf + +bundle config mirror\.SOURCE_URL MIRROR_URL +. +.fi +. +.IP "" 0 +. +.P +For example, to use a mirror of rubygems\.org hosted at rubygems\-mirror\.org: +. +.IP "" 4 +. +.nf + +bundle config mirror\.http://rubygems\.org http://rubygems\-mirror\.org +. +.fi +. +.IP "" 0 +. +.P +Each mirror also provides a fallback timeout setting\. If the mirror does not respond within the fallback timeout, Bundler will try to use the original server instead of the mirror\. +. +.IP "" 4 +. +.nf + +bundle config mirror\.SOURCE_URL\.fallback_timeout TIMEOUT +. +.fi +. +.IP "" 0 +. +.P +For example, to fall back to rubygems\.org after 3 seconds: +. +.IP "" 4 +. +.nf + +bundle config mirror\.https://rubygems\.org\.fallback_timeout 3 +. +.fi +. +.IP "" 0 +. +.P +The default fallback timeout is 0\.1 seconds, but the setting can currently only accept whole seconds (for example, 1, 15, or 30)\. +. +.SH "CREDENTIALS FOR GEM SOURCES" +Bundler allows you to configure credentials for any gem source, which allows you to avoid putting secrets into your Gemfile\. +. +.IP "" 4 +. +.nf + +bundle config SOURCE_HOSTNAME USERNAME:PASSWORD +. +.fi +. +.IP "" 0 +. +.P +For example, to save the credentials of user \fBclaudette\fR for the gem source at \fBgems\.longerous\.com\fR, you would run: +. +.IP "" 4 +. +.nf + +bundle config gems\.longerous\.com claudette:s00pers3krit +. +.fi +. +.IP "" 0 +. +.P +Or you can set the credentials as an environment variable like this: +. +.IP "" 4 +. +.nf + +export BUNDLE_GEMS__LONGEROUS__COM="claudette:s00pers3krit" +. +.fi +. +.IP "" 0 +. +.P +For gems with a git source with HTTP(S) URL you can specify credentials like so: +. +.IP "" 4 +. +.nf + +bundle config https://github\.com/bundler/bundler\.git username:password +. +.fi +. +.IP "" 0 +. +.P +Or you can set the credentials as an environment variable like so: +. +.IP "" 4 +. +.nf + +export BUNDLE_GITHUB__COM=username:password +. +.fi +. +.IP "" 0 +. +.P +This is especially useful for private repositories on hosts such as Github, where you can use personal OAuth tokens: +. +.IP "" 4 +. +.nf + +export BUNDLE_GITHUB__COM=abcd0123generatedtoken:x\-oauth\-basic +. +.fi +. +.IP "" 0 + diff --git a/man/bundle-config.1.txt b/man/bundle-config.1.txt new file mode 100644 index 0000000000..0a999e8a97 --- /dev/null +++ b/man/bundle-config.1.txt @@ -0,0 +1,513 @@ +BUNDLE-CONFIG(1) BUNDLE-CONFIG(1) + + + +1mNAME0m + 1mbundle-config 22m- Set bundler configuration options + +1mSYNOPSIS0m + 1mbundle config 22m[4mname24m [4mvalue24m]] + +1mDESCRIPTION0m + This command allows you to interact with Bundler's configuration sys- + tem. + + Bundler loads configuration settings in this order: + + 1. Local config (1mapp/.bundle/config22m) + + 2. Environmental variables (1mENV22m) + + 3. Global config (1m~/.bundle/config22m) + + 4. Bundler default config + + + + Executing 1mbundle config 22mwith no parameters will print a list of all + bundler configuration for the current bundle, and where that configura- + tion was set. + + Executing 1mbundle config <name> 22mwill print the value of that configura- + tion setting, and where it was set. + + Executing 1mbundle config <name> <value> 22mwill set that configuration to + the value specified for all bundles executed as the current user. The + configuration will be stored in 1m~/.bundle/config22m. If 4mname24m already is + set, 4mname24m will be overridden and user will be warned. + + Executing 1mbundle config --global <name> <value> 22mworks the same as + above. + + Executing 1mbundle config --local <name> <value> 22mwill set that configura- + tion to the local application. The configuration will be stored in + 1mapp/.bundle/config22m. + + Executing 1mbundle config --delete <name> 22mwill delete the configuration + in both local and global sources. Not compatible with --global or + --local flag. + + Executing bundle with the 1mBUNDLE_IGNORE_CONFIG 22menvironment variable set + will cause it to ignore all configuration. + + Executing 1mbundle config disable_multisource true 22mupgrades the warning + about the Gemfile containing multiple primary sources to an error. Exe- + cuting 1mbundle config --delete disable_multisource 22mdowngrades this error + to a warning. + +1mREMEMBERING OPTIONS0m + Flags passed to 1mbundle install 22mor the Bundler runtime, such as 1m--path0m + 1mfoo 22mor 1m--without production22m, are not remembered between commands. If + these options must be remembered,they must be set using 1mbundle config0m + (e.g., 1mbundle config path foo22m). + + The options that can be configured are: + + 1mbin 22mCreates 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 + a 1mrails 22mexecutable, this flag will create a 1mbin/rails 22mexecutable + that ensures that all referred dependencies will be resolved + using the bundled gems. + + 1mdeployment0m + In deployment mode, Bundler will 'roll-out' the bundle for 1mpro-0m + 1mduction 22muse. Please check carefully if you want to have this + option enabled in 1mdevelopment 22mor 1mtest 22menvironments. + + 1mpath 22mThe 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. + + 1mwithout0m + A space-separated list of groups referencing gems to skip during + installation. + + 1mwith 22mA space-separated list of groups referencing gems to include + during installation. + +1mBUILD OPTIONS0m + You can use 1mbundle config 22mto give Bundler the flags to pass to the gem + installer every time bundler tries to install a particular gem. + + A very common example, the 1mmysql 22mgem, requires Snow Leopard users to + pass configuration flags to 1mgem install 22mto specify where to find the + 1mmysql_config 22mexecutable. + + + + gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config + + + + Since the specific location of that executable can change from machine + to machine, you can specify these flags on a per-machine basis. + + + + bundle config build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config + + + + After running this command, every time bundler needs to install the + 1mmysql 22mgem, it will pass along the flags you specified. + +1mCONFIGURATION KEYS0m + Configuration keys in bundler have two forms: the canonical form and + the environment variable form. + + For instance, passing the 1m--without 22mflag to bundle install(1) 4mbun-0m + 4mdle-install.1.html24m prevents Bundler from installing certain groups + specified in the Gemfile(5). Bundler persists this value in 1mapp/.bun-0m + 1mdle/config 22mso that calls to 1mBundler.setup 22mdo not try to find gems from + the 1mGemfile 22mthat you didn't install. Additionally, subsequent calls to + bundle install(1) 4mbundle-install.1.html24m remember this setting and skip + those groups. + + The canonical form of this configuration is 1m"without"22m. To convert the + canonical form to the environment variable form, capitalize it, and + prepend 1mBUNDLE_22m. The environment variable form of 1m"without" 22mis 1mBUN-0m + 1mDLE_WITHOUT22m. + + Any periods in the configuration keys must be replaced with two under- + scores when setting it via environment variables. The configuration key + 1mlocal.rack 22mbecomes the environment variable 1mBUNDLE_LOCAL__RACK22m. + +1mLIST OF AVAILABLE KEYS0m + The following is a list of all configuration keys and their purpose. + You can learn more about their operation in bundle install(1) 4mbun-0m + 4mdle-install.1.html24m. + + o 1mallow_bundler_dependency_conflicts 22m(1mBUNDLE_ALLOW_BUNDLER_DEPEN-0m + 1mDENCY_CONFLICTS22m): Allow resolving to specifications that have + dependencies on 1mbundler 22mthat are incompatible with the running + Bundler version. + + o 1mallow_deployment_source_credential_changes 22m(1mBUNDLE_ALLOW_DEPLOY-0m + 1mMENT_SOURCE_CREDENTIAL_CHANGES22m): When in deployment mode, allow + changing the credentials to a gem's source. Ex: + 1mhttps://some.host.com/gems/path/ 22m-> 1mhttps://user_name:pass-0m + 1mword@some.host.com/gems/path0m + + o 1mallow_offline_install 22m(1mBUNDLE_ALLOW_OFFLINE_INSTALL22m): Allow Bundler + to use cached data when installing without network access. + + o 1mauto_clean_without_path 22m(1mBUNDLE_AUTO_CLEAN_WITHOUT_PATH22m): Automati- + cally run 1mbundle clean 22mafter installing when an explicit 1mpath 22mhas + not been set and Bundler is not installing into the system gems. + + o 1mauto_install 22m(1mBUNDLE_AUTO_INSTALL22m): Automatically run 1mbundle0m + 1minstall 22mwhen gems are missing. + + o 1mbin 22m(1mBUNDLE_BIN22m): Install executables from gems in the bundle to + the specified directory. Defaults to 1mfalse22m. + + o 1mcache_all 22m(1mBUNDLE_CACHE_ALL22m): Cache all gems, including path and + git gems. + + o 1mcache_all_platforms 22m(1mBUNDLE_CACHE_ALL_PLATFORMS22m): Cache gems for + all platforms. + + o 1mcache_path 22m(1mBUNDLE_CACHE_PATH22m): The directory that bundler will + place cached gems in when running 1mbundle package22m, and that bundler + will look in when installing gems. Defaults to 1mvendor/bundle22m. + + o 1mclean 22m(1mBUNDLE_CLEAN22m): Whether Bundler should run 1mbundle clean 22mauto- + matically after 1mbundle install22m. + + o 1mconsole 22m(1mBUNDLE_CONSOLE22m): The console that 1mbundle console 22mstarts. + Defaults to 1mirb22m. + + o 1mdefault_install_uses_path 22m(1mBUNDLE_DEFAULT_INSTALL_USES_PATH22m): + Whether a 1mbundle install 22mwithout an explicit 1m--path 22margument + defaults to installing gems in 1m.bundle22m. + + o 1mdeployment 22m(1mBUNDLE_DEPLOYMENT22m): Disallow changes to the 1mGemfile22m. + When the 1mGemfile 22mis changed and the lockfile has not been updated, + running Bundler commands will be blocked. + + o 1mdisable_checksum_validation 22m(1mBUNDLE_DISABLE_CHECKSUM_VALIDATION22m): + Allow installing gems even if they do not match the checksum pro- + vided by RubyGems. + + o 1mdisable_exec_load 22m(1mBUNDLE_DISABLE_EXEC_LOAD22m): Stop Bundler from + using 1mload 22mto launch an executable in-process in 1mbundle exec22m. + + o 1mdisable_local_branch_check 22m(1mBUNDLE_DISABLE_LOCAL_BRANCH_CHECK22m): + Allow Bundler to use a local git override without a branch speci- + fied in the Gemfile. + + o 1mdisable_multisource 22m(1mBUNDLE_DISABLE_MULTISOURCE22m): When set, Gem- + files containing multiple sources will produce errors instead of + warnings. Use 1mbundle config --delete disable_multisource 22mto unset. + + o 1mdisable_platform_warnings 22m(1mBUNDLE_DISABLE_PLATFORM_WARNINGS22m): Dis- + able warnings during bundle install when a dependency is unused on + the current platform. + + o 1mdisable_shared_gems 22m(1mBUNDLE_DISABLE_SHARED_GEMS22m): Stop Bundler from + accessing gems installed to RubyGems' normal location. + + o 1mdisable_version_check 22m(1mBUNDLE_DISABLE_VERSION_CHECK22m): Stop Bundler + from checking if a newer Bundler version is available on + rubygems.org. + + o 1merror_on_stderr 22m(1mBUNDLE_ERROR_ON_STDERR22m): Print Bundler errors to + stderr. + + o 1mforce_ruby_platform 22m(1mBUNDLE_FORCE_RUBY_PLATFORM22m): Ignore the cur- + rent machine's platform and install only 1mruby 22mplatform gems. As a + result, gems with native extensions will be compiled from source. + + o 1mfrozen 22m(1mBUNDLE_FROZEN22m): Disallow changes to the 1mGemfile22m. When the + 1mGemfile 22mis changed and the lockfile has not been updated, running + Bundler commands will be blocked. Defaults to 1mtrue 22mwhen 1m--deploy-0m + 1mment 22mis used. + + o 1mgem.push_key 22m(1mBUNDLE_GEM__PUSH_KEY22m): Sets the 1m--key 22mparameter for + 1mgem push 22mwhen using the 1mrake release 22mcommand with a private gem- + stash server. + + o 1mgemfile 22m(1mBUNDLE_GEMFILE22m): The name of the file that bundler should + use as the 1mGemfile22m. This location of this file also sets the root + of the project, which is used to resolve relative paths in the 1mGem-0m + 1mfile22m, among other things. By default, bundler will search up from + the current working directory until it finds a 1mGemfile22m. + + o 1mglobal_gem_cache 22m(1mBUNDLE_GLOBAL_GEM_CACHE22m): Whether Bundler should + cache all gems globally, rather than locally to the installing Ruby + installation. + + o 1mglobal_path_appends_ruby_scope 22m(1mBUN-0m + 1mDLE_GLOBAL_PATH_APPENDS_RUBY_SCOPE22m): Whether Bundler should append + the Ruby scope (e.g. engine and ABI version) to a globally-config- + ured path. + + o 1mignore_messages 22m(1mBUNDLE_IGNORE_MESSAGES22m): When set, no post install + messages will be printed. To silence a single gem, use dot notation + like 1mignore_messages.httparty true22m. + + o 1minit_gems_rb 22m(1mBUNDLE_INIT_GEMS_RB22m) Generate a 1mgems.rb 22minstead of a + 1mGemfile 22mwhen running 1mbundle init22m. + + o 1mjobs 22m(1mBUNDLE_JOBS22m): The number of gems Bundler can install in par- + allel. Defaults to 1. + + o 1mlist_command 22m(1mBUNDLE_LIST_COMMAND22m) Enable new list command feature + + o 1mmajor_deprecations 22m(1mBUNDLE_MAJOR_DEPRECATIONS22m): Whether Bundler + should print deprecation warnings for behavior that will be changed + in the next major version. + + o 1mno_install 22m(1mBUNDLE_NO_INSTALL22m): Whether 1mbundle package 22mshould skip + installing gems. + + o 1mno_prune 22m(1mBUNDLE_NO_PRUNE22m): Whether Bundler should leave outdated + gems unpruned when caching. + + o 1monly_update_to_newer_versions 22m(1mBUNDLE_ONLY_UPDATE_TO_NEWER_VER-0m + 1mSIONS22m): During 1mbundle update22m, only resolve to newer versions of the + gems in the lockfile. + + o 1mpath 22m(1mBUNDLE_PATH22m): The location on disk where all gems in your + bundle will be located regardless of 1m$GEM_HOME 22mor 1m$GEM_PATH 22mvalues. + Bundle gems not found in this location will be installed by 1mbundle0m + 1minstall22m. Defaults to 1mGem.dir22m. When --deployment is used, defaults + to vendor/bundle. + + 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(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. + + o 1mprefer_gems_rb 22m(1mBUNDLE_PREFER_GEMS_RB22m) Prefer 1mgems.rb 22mto 1mGemfile0m + when Bundler is searching for a Gemfile. + + o 1mprint_only_version_number 22m(1mBUNDLE_PRINT_ONLY_VERSION_NUMBER22m) Print + only version number from 1mbundler --version22m. + + o 1mredirect 22m(1mBUNDLE_REDIRECT22m): The number of redirects allowed for + network requests. Defaults to 1m522m. + + o 1mretry 22m(1mBUNDLE_RETRY22m): The number of times to retry failed network + requests. Defaults to 1m322m. + + o 1msetup_makes_kernel_gem_public 22m(1mBUNDLE_SETUP_MAKES_KERNEL_GEM_PUB-0m + 1mLIC22m): Have 1mBundler.setup 22mmake the 1mKernel#gem 22mmethod public, even + though RubyGems declares it as private. + + o 1mshebang 22m(1mBUNDLE_SHEBANG22m): The program name that should be invoked + for generated binstubs. Defaults to the ruby install name used to + generate the binstub. + + o 1msilence_root_warning 22m(1mBUNDLE_SILENCE_ROOT_WARNING22m): Silence the + warning Bundler prints when installing gems as root. + + o 1mskip_default_git_sources 22m(1mBUNDLE_SKIP_DEFAULT_GIT_SOURCES22m): Whether + Bundler should skip adding default git source shortcuts to the Gem- + file DSL. + + o 1mspecific_platform 22m(1mBUNDLE_SPECIFIC_PLATFORM22m): Allow bundler to + resolve for the specific running platform and store it in the lock- + file, instead of only using a generic platform. A specific platform + is the exact platform triple reported by 1mGem::Platform.local22m, such + as 1mx86_64-darwin-16 22mor 1muniversal-java-1.822m. On the other hand, + generic platforms are those such as 1mruby22m, 1mmswin22m, or 1mjava22m. In this + example, 1mx86_64-darwin-16 22mwould map to 1mruby 22mand 1muniversal-java-1.80m + to 1mjava22m. + + o 1mssl_ca_cert 22m(1mBUNDLE_SSL_CA_CERT22m): Path to a designated CA certifi- + cate file or folder containing multiple certificates for trusted + CAs in PEM format. + + o 1mssl_client_cert 22m(1mBUNDLE_SSL_CLIENT_CERT22m): Path to a designated file + containing a X.509 client certificate and key in PEM format. + + o 1mssl_verify_mode 22m(1mBUNDLE_SSL_VERIFY_MODE22m): The SSL verification mode + Bundler uses when making HTTPS requests. Defaults to verify peer. + + o 1msuppress_install_using_messages 22m(1mBUNDLE_SUPPRESS_INSTALL_USING_MES-0m + 1mSAGES22m): Avoid printing 1mUsing ... 22mmessages during installation when + the version of a gem has not changed. + + o 1msystem_bindir 22m(1mBUNDLE_SYSTEM_BINDIR22m): The location where RubyGems + installs binstubs. Defaults to 1mGem.bindir22m. + + o 1mtimeout 22m(1mBUNDLE_TIMEOUT22m): The seconds allowed before timing out for + network requests. Defaults to 1m1022m. + + o 1munlock_source_unlocks_spec 22m(1mBUNDLE_UNLOCK_SOURCE_UNLOCKS_SPEC22m): + Whether running 1mbundle update --source NAME 22munlocks a gem with the + given name. Defaults to 1mtrue22m. + + o 1mupdate_requires_all_flag 22m(1mBUNDLE_UPDATE_REQUIRES_ALL_FLAG22m) Require + passing 1m--all 22mto 1mbundle update 22mwhen everything should be updated, + and disallow passing no options to 1mbundle update22m. + + o 1muser_agent 22m(1mBUNDLE_USER_AGENT22m): The custom user agent fragment + Bundler includes in API requests. + + o 1mwith 22m(1mBUNDLE_WITH22m): A 1m:22m-separated list of groups whose gems bundler + should install. + + o 1mwithout 22m(1mBUNDLE_WITHOUT22m): A 1m:22m-separated list of groups whose gems + bundler should not install. + + + + In general, you should set these settings per-application by using the + applicable flag to the bundle install(1) 4mbundle-install.1.html24m or bun- + dle package(1) 4mbundle-package.1.html24m command. + + You can set them globally either via environment variables or 1mbundle0m + 1mconfig22m, whichever is preferable for your setup. If you use both, envi- + ronment variables will take preference over global settings. + +1mLOCAL GIT REPOS0m + Bundler also allows you to work against a git repository locally + instead of using the remote version. This can be achieved by setting up + a local override: + + + + bundle config local.GEM_NAME /path/to/local/git/repository + + + + For example, in order to use a local Rack repository, a developer could + call: + + + + bundle config local.rack ~/Work/git/rack + + + + Now instead of checking out the remote git repository, the local over- + ride will be used. Similar to a path source, every time the local git + repository change, changes will be automatically picked up by Bundler. + This means a commit in the local git repo will update the revision in + the 1mGemfile.lock 22mto the local git repo revision. This requires the same + attention as git submodules. Before pushing to the remote, you need to + ensure the local override was pushed, otherwise you may point to a com- + mit that only exists in your local machine. You'll also need to CGI + escape your usernames and passwords as well. + + Bundler does many checks to ensure a developer won't work with invalid + references. Particularly, we force a developer to specify a branch in + the 1mGemfile 22min order to use this feature. If the branch specified in + the 1mGemfile 22mand the current branch in the local git repository do not + match, Bundler will abort. This ensures that a developer is always + working against the correct branches, and prevents accidental locking + to a different branch. + + Finally, Bundler also ensures that the current revision in the 1mGem-0m + 1mfile.lock 22mexists in the local git repository. By doing this, Bundler + forces you to fetch the latest changes in the remotes. + +1mMIRRORS OF GEM SOURCES0m + Bundler supports overriding gem sources with mirrors. This allows you + to configure rubygems.org as the gem source in your Gemfile while still + using your mirror to fetch gems. + + + + bundle config mirror.SOURCE_URL MIRROR_URL + + + + For example, to use a mirror of rubygems.org hosted at rubygems-mir- + ror.org: + + + + bundle config mirror.http://rubygems.org http://rubygems-mirror.org + + + + Each mirror also provides a fallback timeout setting. If the mirror + does not respond within the fallback timeout, Bundler will try to use + the original server instead of the mirror. + + + + bundle config mirror.SOURCE_URL.fallback_timeout TIMEOUT + + + + For example, to fall back to rubygems.org after 3 seconds: + + + + bundle config mirror.https://rubygems.org.fallback_timeout 3 + + + + The default fallback timeout is 0.1 seconds, but the setting can cur- + rently only accept whole seconds (for example, 1, 15, or 30). + +1mCREDENTIALS FOR GEM SOURCES0m + Bundler allows you to configure credentials for any gem source, which + allows you to avoid putting secrets into your Gemfile. + + + + bundle config SOURCE_HOSTNAME USERNAME:PASSWORD + + + + For example, to save the credentials of user 1mclaudette 22mfor the gem + source at 1mgems.longerous.com22m, you would run: + + + + bundle config gems.longerous.com claudette:s00pers3krit + + + + Or you can set the credentials as an environment variable like this: + + + + export BUNDLE_GEMS__LONGEROUS__COM="claudette:s00pers3krit" + + + + For gems with a git source with HTTP(S) URL you can specify credentials + like so: + + + + bundle config https://github.com/bundler/bundler.git username:password + + + + Or you can set the credentials as an environment variable like so: + + + + export BUNDLE_GITHUB__COM=username:password + + + + This is especially useful for private repositories on hosts such as + Github, where you can use personal OAuth tokens: + + + + export BUNDLE_GITHUB__COM=abcd0123generatedtoken:x-oauth-basic + + + + + + + October 2018 BUNDLE-CONFIG(1) diff --git a/man/bundle-config.ronn b/man/bundle-config.ronn new file mode 100644 index 0000000000..b5c97ae82d --- /dev/null +++ b/man/bundle-config.ronn @@ -0,0 +1,397 @@ +bundle-config(1) -- Set bundler configuration options +===================================================== + +## SYNOPSIS + +`bundle config` [<name> [<value>]] + +## DESCRIPTION + +This command allows you to interact with Bundler's configuration system. + +Bundler loads configuration settings in this order: + +1. Local config (`app/.bundle/config`) +2. Environmental variables (`ENV`) +3. Global config (`~/.bundle/config`) +4. Bundler default config + +Executing `bundle config` with no parameters will print a list of all +bundler configuration for the current bundle, and where that configuration +was set. + +Executing `bundle config <name>` will print the value of that configuration +setting, and where it was set. + +Executing `bundle config <name> <value>` will set that configuration to the +value specified for all bundles executed as the current user. The configuration +will be stored in `~/.bundle/config`. If <name> already is set, <name> will be +overridden and user will be warned. + +Executing `bundle config --global <name> <value>` works the same as above. + +Executing `bundle config --local <name> <value>` will set that configuration to +the local application. The configuration will be stored in `app/.bundle/config`. + +Executing `bundle config --delete <name>` will delete the configuration in both +local and global sources. Not compatible with --global or --local flag. + +Executing bundle with the `BUNDLE_IGNORE_CONFIG` environment variable set will +cause it to ignore all configuration. + +Executing `bundle config disable_multisource true` upgrades the warning about +the Gemfile containing multiple primary sources to an error. Executing `bundle +config --delete disable_multisource` downgrades this error to a warning. + +## REMEMBERING OPTIONS + +Flags passed to `bundle install` or the Bundler runtime, +such as `--path foo` or `--without production`, are not remembered between commands. +If these options must be remembered,they must be set using `bundle config` +(e.g., `bundle config path foo`). + +The options that can be configured are: + +* `bin`: + Creates a directory (defaults to `~/bin`) 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 `PATH` variable. For instance, if the + `rails` gem comes with a `rails` executable, this flag will create a + `bin/rails` executable that ensures that all referred dependencies will be + resolved using the bundled gems. + +* `deployment`: + In deployment mode, Bundler will 'roll-out' the bundle for + `production` use. Please check carefully if you want to have this option + enabled in `development` or `test` environments. + +* `path`: + 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`. Accordingly, gems + installed to other locations will not get listed. + +* `without`: + A space-separated list of groups referencing gems to skip during installation. + +* `with`: + A space-separated list of groups referencing gems to include during installation. + +## BUILD OPTIONS + +You can use `bundle config` to give Bundler the flags to pass to the gem +installer every time bundler tries to install a particular gem. + +A very common example, the `mysql` gem, requires Snow Leopard users to +pass configuration flags to `gem install` to specify where to find the +`mysql_config` executable. + + gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config + +Since the specific location of that executable can change from machine +to machine, you can specify these flags on a per-machine basis. + + bundle config build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config + +After running this command, every time bundler needs to install the +`mysql` gem, it will pass along the flags you specified. + +## CONFIGURATION KEYS + +Configuration keys in bundler have two forms: the canonical form and the +environment variable form. + +For instance, passing the `--without` flag to [bundle install(1)](bundle-install.1.html) +prevents Bundler from installing certain groups specified in the Gemfile(5). Bundler +persists this value in `app/.bundle/config` so that calls to `Bundler.setup` +do not try to find gems from the `Gemfile` that you didn't install. Additionally, +subsequent calls to [bundle install(1)](bundle-install.1.html) remember this setting +and skip those groups. + +The canonical form of this configuration is `"without"`. To convert the canonical +form to the environment variable form, capitalize it, and prepend `BUNDLE_`. The +environment variable form of `"without"` is `BUNDLE_WITHOUT`. + +Any periods in the configuration keys must be replaced with two underscores when +setting it via environment variables. The configuration key `local.rack` becomes +the environment variable `BUNDLE_LOCAL__RACK`. + +## LIST OF AVAILABLE KEYS + +The following is a list of all configuration keys and their purpose. You can +learn more about their operation in [bundle install(1)](bundle-install.1.html). + +* `allow_bundler_dependency_conflicts` (`BUNDLE_ALLOW_BUNDLER_DEPENDENCY_CONFLICTS`): + Allow resolving to specifications that have dependencies on `bundler` that + are incompatible with the running Bundler version. +* `allow_deployment_source_credential_changes` (`BUNDLE_ALLOW_DEPLOYMENT_SOURCE_CREDENTIAL_CHANGES`): + When in deployment mode, allow changing the credentials to a gem's source. + Ex: `https://some.host.com/gems/path/` -> `https://user_name:password@some.host.com/gems/path` +* `allow_offline_install` (`BUNDLE_ALLOW_OFFLINE_INSTALL`): + Allow Bundler to use cached data when installing without network access. +* `auto_clean_without_path` (`BUNDLE_AUTO_CLEAN_WITHOUT_PATH`): + Automatically run `bundle clean` after installing when an explicit `path` + has not been set and Bundler is not installing into the system gems. +* `auto_install` (`BUNDLE_AUTO_INSTALL`): + Automatically run `bundle install` when gems are missing. +* `bin` (`BUNDLE_BIN`): + Install executables from gems in the bundle to the specified directory. + Defaults to `false`. +* `cache_all` (`BUNDLE_CACHE_ALL`): + Cache all gems, including path and git gems. +* `cache_all_platforms` (`BUNDLE_CACHE_ALL_PLATFORMS`): + Cache gems for all platforms. +* `cache_path` (`BUNDLE_CACHE_PATH`): + The directory that bundler will place cached gems in when running + <code>bundle package</code>, and that bundler will look in when installing gems. + Defaults to `vendor/bundle`. +* `clean` (`BUNDLE_CLEAN`): + Whether Bundler should run `bundle clean` automatically after + `bundle install`. +* `console` (`BUNDLE_CONSOLE`): + The console that `bundle console` starts. Defaults to `irb`. +* `default_install_uses_path` (`BUNDLE_DEFAULT_INSTALL_USES_PATH`): + Whether a `bundle install` without an explicit `--path` argument defaults + to installing gems in `.bundle`. +* `deployment` (`BUNDLE_DEPLOYMENT`): + Disallow changes to the `Gemfile`. When the `Gemfile` is changed and the + lockfile has not been updated, running Bundler commands will be blocked. +* `disable_checksum_validation` (`BUNDLE_DISABLE_CHECKSUM_VALIDATION`): + Allow installing gems even if they do not match the checksum provided by + RubyGems. +* `disable_exec_load` (`BUNDLE_DISABLE_EXEC_LOAD`): + Stop Bundler from using `load` to launch an executable in-process in + `bundle exec`. +* `disable_local_branch_check` (`BUNDLE_DISABLE_LOCAL_BRANCH_CHECK`): + Allow Bundler to use a local git override without a branch specified in the + Gemfile. +* `disable_multisource` (`BUNDLE_DISABLE_MULTISOURCE`): + When set, Gemfiles containing multiple sources will produce errors + instead of warnings. + Use `bundle config --delete disable_multisource` to unset. +* `disable_platform_warnings` (`BUNDLE_DISABLE_PLATFORM_WARNINGS`): + Disable warnings during bundle install when a dependency is unused on the current platform. +* `disable_shared_gems` (`BUNDLE_DISABLE_SHARED_GEMS`): + Stop Bundler from accessing gems installed to RubyGems' normal location. +* `disable_version_check` (`BUNDLE_DISABLE_VERSION_CHECK`): + Stop Bundler from checking if a newer Bundler version is available on + rubygems.org. +* `error_on_stderr` (`BUNDLE_ERROR_ON_STDERR`): + Print Bundler errors to stderr. +* `force_ruby_platform` (`BUNDLE_FORCE_RUBY_PLATFORM`): + Ignore the current machine's platform and install only `ruby` platform gems. + As a result, gems with native extensions will be compiled from source. +* `frozen` (`BUNDLE_FROZEN`): + Disallow changes to the `Gemfile`. When the `Gemfile` is changed and the + lockfile has not been updated, running Bundler commands will be blocked. + Defaults to `true` when `--deployment` is used. +* `gem.push_key` (`BUNDLE_GEM__PUSH_KEY`): + Sets the `--key` parameter for `gem push` when using the `rake release` + command with a private gemstash server. +* `gemfile` (`BUNDLE_GEMFILE`): + The name of the file that bundler should use as the `Gemfile`. This location + of this file also sets the root of the project, which is used to resolve + relative paths in the `Gemfile`, among other things. By default, bundler + will search up from the current working directory until it finds a + `Gemfile`. +* `global_gem_cache` (`BUNDLE_GLOBAL_GEM_CACHE`): + Whether Bundler should cache all gems globally, rather than locally to the + installing Ruby installation. +* `global_path_appends_ruby_scope` (`BUNDLE_GLOBAL_PATH_APPENDS_RUBY_SCOPE`): + Whether Bundler should append the Ruby scope (e.g. engine and ABI version) + to a globally-configured path. +* `ignore_messages` (`BUNDLE_IGNORE_MESSAGES`): When set, no post install + messages will be printed. To silence a single gem, use dot notation like + `ignore_messages.httparty true`. +* `init_gems_rb` (`BUNDLE_INIT_GEMS_RB`) + Generate a `gems.rb` instead of a `Gemfile` when running `bundle init`. +* `jobs` (`BUNDLE_JOBS`): + The number of gems Bundler can install in parallel. Defaults to 1. +* `list_command` (`BUNDLE_LIST_COMMAND`) + Enable new list command feature +* `major_deprecations` (`BUNDLE_MAJOR_DEPRECATIONS`): + Whether Bundler should print deprecation warnings for behavior that will + be changed in the next major version. +* `no_install` (`BUNDLE_NO_INSTALL`): + Whether `bundle package` should skip installing gems. +* `no_prune` (`BUNDLE_NO_PRUNE`): + Whether Bundler should leave outdated gems unpruned when caching. +* `only_update_to_newer_versions` (`BUNDLE_ONLY_UPDATE_TO_NEWER_VERSIONS`): + During `bundle update`, only resolve to newer versions of the gems in the + lockfile. +* `path` (`BUNDLE_PATH`): + The location on disk where all gems in your bundle will be located regardless + of `$GEM_HOME` or `$GEM_PATH` values. Bundle gems not found in this location + will be installed by `bundle install`. Defaults to `Gem.dir`. When --deployment + is used, defaults to vendor/bundle. +* `path.system` (`BUNDLE_PATH__SYSTEM`): + Whether Bundler will install gems into the default system path (`Gem.dir`). +* `path_relative_to_cwd` (`PATH_RELATIVE_TO_CWD`) + Makes `--path` relative to the CWD instead of the `Gemfile`. +* `plugins` (`BUNDLE_PLUGINS`): + Enable Bundler's experimental plugin system. +* `prefer_gems_rb` (`BUNDLE_PREFER_GEMS_RB`) + Prefer `gems.rb` to `Gemfile` when Bundler is searching for a Gemfile. +* `print_only_version_number` (`BUNDLE_PRINT_ONLY_VERSION_NUMBER`) + Print only version number from `bundler --version`. +* `redirect` (`BUNDLE_REDIRECT`): + The number of redirects allowed for network requests. Defaults to `5`. +* `retry` (`BUNDLE_RETRY`): + The number of times to retry failed network requests. Defaults to `3`. +* `setup_makes_kernel_gem_public` (`BUNDLE_SETUP_MAKES_KERNEL_GEM_PUBLIC`): + Have `Bundler.setup` make the `Kernel#gem` method public, even though + RubyGems declares it as private. +* `shebang` (`BUNDLE_SHEBANG`): + The program name that should be invoked for generated binstubs. Defaults to + the ruby install name used to generate the binstub. +* `silence_root_warning` (`BUNDLE_SILENCE_ROOT_WARNING`): + Silence the warning Bundler prints when installing gems as root. +* `skip_default_git_sources` (`BUNDLE_SKIP_DEFAULT_GIT_SOURCES`): + Whether Bundler should skip adding default git source shortcuts to the + Gemfile DSL. +* `specific_platform` (`BUNDLE_SPECIFIC_PLATFORM`): + Allow bundler to resolve for the specific running platform and store it in + the lockfile, instead of only using a generic platform. + A specific platform is the exact platform triple reported by + `Gem::Platform.local`, such as `x86_64-darwin-16` or `universal-java-1.8`. + On the other hand, generic platforms are those such as `ruby`, `mswin`, or + `java`. In this example, `x86_64-darwin-16` would map to `ruby` and + `universal-java-1.8` to `java`. +* `ssl_ca_cert` (`BUNDLE_SSL_CA_CERT`): + Path to a designated CA certificate file or folder containing multiple + certificates for trusted CAs in PEM format. +* `ssl_client_cert` (`BUNDLE_SSL_CLIENT_CERT`): + Path to a designated file containing a X.509 client certificate + and key in PEM format. +* `ssl_verify_mode` (`BUNDLE_SSL_VERIFY_MODE`): + The SSL verification mode Bundler uses when making HTTPS requests. + Defaults to verify peer. +* `suppress_install_using_messages` (`BUNDLE_SUPPRESS_INSTALL_USING_MESSAGES`): + Avoid printing `Using ...` messages during installation when the version of + a gem has not changed. +* `system_bindir` (`BUNDLE_SYSTEM_BINDIR`): + The location where RubyGems installs binstubs. Defaults to `Gem.bindir`. +* `timeout` (`BUNDLE_TIMEOUT`): + The seconds allowed before timing out for network requests. Defaults to `10`. +* `unlock_source_unlocks_spec` (`BUNDLE_UNLOCK_SOURCE_UNLOCKS_SPEC`): + Whether running `bundle update --source NAME` unlocks a gem with the given + name. Defaults to `true`. +* `update_requires_all_flag` (`BUNDLE_UPDATE_REQUIRES_ALL_FLAG`) + Require passing `--all` to `bundle update` when everything should be updated, + and disallow passing no options to `bundle update`. +* `user_agent` (`BUNDLE_USER_AGENT`): + The custom user agent fragment Bundler includes in API requests. +* `with` (`BUNDLE_WITH`): + A `:`-separated list of groups whose gems bundler should install. +* `without` (`BUNDLE_WITHOUT`): + A `:`-separated list of groups whose gems bundler should not install. + +In general, you should set these settings per-application by using the applicable +flag to the [bundle install(1)](bundle-install.1.html) or [bundle package(1)](bundle-package.1.html) command. + +You can set them globally either via environment variables or `bundle config`, +whichever is preferable for your setup. If you use both, environment variables +will take preference over global settings. + +## LOCAL GIT REPOS + +Bundler also allows you to work against a git repository locally +instead of using the remote version. This can be achieved by setting +up a local override: + + bundle config local.GEM_NAME /path/to/local/git/repository + +For example, in order to use a local Rack repository, a developer could call: + + bundle config local.rack ~/Work/git/rack + +Now instead of checking out the remote git repository, the local +override will be used. Similar to a path source, every time the local +git repository change, changes will be automatically picked up by +Bundler. This means a commit in the local git repo will update the +revision in the `Gemfile.lock` to the local git repo revision. This +requires the same attention as git submodules. Before pushing to +the remote, you need to ensure the local override was pushed, otherwise +you may point to a commit that only exists in your local machine. +You'll also need to CGI escape your usernames and passwords as well. + +Bundler does many checks to ensure a developer won't work with +invalid references. Particularly, we force a developer to specify +a branch in the `Gemfile` in order to use this feature. If the branch +specified in the `Gemfile` and the current branch in the local git +repository do not match, Bundler will abort. This ensures that +a developer is always working against the correct branches, and prevents +accidental locking to a different branch. + +Finally, Bundler also ensures that the current revision in the +`Gemfile.lock` exists in the local git repository. By doing this, Bundler +forces you to fetch the latest changes in the remotes. + +## MIRRORS OF GEM SOURCES + +Bundler supports overriding gem sources with mirrors. This allows you to +configure rubygems.org as the gem source in your Gemfile while still using your +mirror to fetch gems. + + bundle config mirror.SOURCE_URL MIRROR_URL + +For example, to use a mirror of rubygems.org hosted at rubygems-mirror.org: + + bundle config mirror.http://rubygems.org http://rubygems-mirror.org + +Each mirror also provides a fallback timeout setting. If the mirror does not +respond within the fallback timeout, Bundler will try to use the original +server instead of the mirror. + + bundle config mirror.SOURCE_URL.fallback_timeout TIMEOUT + +For example, to fall back to rubygems.org after 3 seconds: + + bundle config mirror.https://rubygems.org.fallback_timeout 3 + +The default fallback timeout is 0.1 seconds, but the setting can currently +only accept whole seconds (for example, 1, 15, or 30). + +## CREDENTIALS FOR GEM SOURCES + +Bundler allows you to configure credentials for any gem source, which allows +you to avoid putting secrets into your Gemfile. + + bundle config SOURCE_HOSTNAME USERNAME:PASSWORD + +For example, to save the credentials of user `claudette` for the gem source at +`gems.longerous.com`, you would run: + + bundle config gems.longerous.com claudette:s00pers3krit + +Or you can set the credentials as an environment variable like this: + + export BUNDLE_GEMS__LONGEROUS__COM="claudette:s00pers3krit" + +For gems with a git source with HTTP(S) URL you can specify credentials like so: + + bundle config https://github.com/bundler/bundler.git username:password + +Or you can set the credentials as an environment variable like so: + + export BUNDLE_GITHUB__COM=username:password + +This is especially useful for private repositories on hosts such as Github, +where you can use personal OAuth tokens: + + export BUNDLE_GITHUB__COM=abcd0123generatedtoken:x-oauth-basic + + +## CONFIGURE BUNDLER DIRECTORIES + +Bundler's home, config, cache and plugin directories are able to be configured +through environment variables. The default location for Bundler's home directory is +`~/.bundle`, which all directories inherit from by default. The following +outlines the available environment variables and their default values + + BUNDLE_USER_HOME : $HOME/.bundle + BUNDLE_USER_CACHE : $BUNDLE_USER_HOME/cache + BUNDLE_USER_CONFIG : $BUNDLE_USER_HOME/config + BUNDLE_USER_PLUGIN : $BUNDLE_USER_HOME/plugin + diff --git a/man/bundle-doctor.1 b/man/bundle-doctor.1 new file mode 100644 index 0000000000..e31d99c856 --- /dev/null +++ b/man/bundle-doctor.1 @@ -0,0 +1,44 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BUNDLE\-DOCTOR" "1" "June 2018" "" "" +. +.SH "NAME" +\fBbundle\-doctor\fR \- Checks the bundle for common problems +. +.SH "SYNOPSIS" +\fBbundle doctor\fR [\-\-quiet] [\-\-gemfile=GEMFILE] +. +.SH "DESCRIPTION" +Checks your Gemfile and gem environment for common problems\. If issues are detected, Bundler prints them and exits status 1\. Otherwise, Bundler prints a success message and exits status 0\. +. +.P +Examples of common problems caught by bundle\-doctor include: +. +.IP "\(bu" 4 +Invalid Bundler settings +. +.IP "\(bu" 4 +Mismatched Ruby versions +. +.IP "\(bu" 4 +Mismatched platforms +. +.IP "\(bu" 4 +Uninstalled gems +. +.IP "\(bu" 4 +Missing dependencies +. +.IP "" 0 +. +.SH "OPTIONS" +. +.TP +\fB\-\-quiet\fR +Only output warnings and errors\. +. +.TP +\fB\-\-gemfile=<gemfile>\fR +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 \fBGemfile\.lock\fR and \fBvendor/cache\fR relative to this location\. + diff --git a/man/bundle-doctor.1.txt b/man/bundle-doctor.1.txt new file mode 100644 index 0000000000..b4144b6bca --- /dev/null +++ b/man/bundle-doctor.1.txt @@ -0,0 +1,44 @@ +BUNDLE-DOCTOR(1) BUNDLE-DOCTOR(1) + + + +1mNAME0m + 1mbundle-doctor 22m- Checks the bundle for common problems + +1mSYNOPSIS0m + 1mbundle doctor 22m[--quiet] [--gemfile=GEMFILE] + +1mDESCRIPTION0m + Checks your Gemfile and gem environment for common problems. If issues + are detected, Bundler prints them and exits status 1. Otherwise, + Bundler prints a success message and exits status 0. + + Examples of common problems caught by bundle-doctor include: + + o Invalid Bundler settings + + o Mismatched Ruby versions + + o Mismatched platforms + + o Uninstalled gems + + o Missing dependencies + + + +1mOPTIONS0m + 1m--quiet0m + Only output warnings and errors. + + 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 + 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. + + + + + June 2018 BUNDLE-DOCTOR(1) diff --git a/man/bundle-doctor.ronn b/man/bundle-doctor.ronn new file mode 100644 index 0000000000..271ee800ad --- /dev/null +++ b/man/bundle-doctor.ronn @@ -0,0 +1,33 @@ +bundle-doctor(1) -- Checks the bundle for common problems +========================================================= + +## SYNOPSIS + +`bundle doctor` [--quiet] + [--gemfile=GEMFILE] + +## DESCRIPTION + +Checks your Gemfile and gem environment for common problems. If issues +are detected, Bundler prints them and exits status 1. Otherwise, +Bundler prints a success message and exits status 0. + +Examples of common problems caught by bundle-doctor include: + +* Invalid Bundler settings +* Mismatched Ruby versions +* Mismatched platforms +* Uninstalled gems +* Missing dependencies + +## OPTIONS + +* `--quiet`: + Only output warnings and errors. + +* `--gemfile=<gemfile>`: + 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 `Gemfile.lock` and `vendor/cache` relative + to this location. diff --git a/man/bundle-exec.1 b/man/bundle-exec.1 new file mode 100644 index 0000000000..48c446c206 --- /dev/null +++ b/man/bundle-exec.1 @@ -0,0 +1,165 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BUNDLE\-EXEC" "1" "October 2018" "" "" +. +.SH "NAME" +\fBbundle\-exec\fR \- Execute a command in the context of the bundle +. +.SH "SYNOPSIS" +\fBbundle exec\fR [\-\-keep\-file\-descriptors] \fIcommand\fR +. +.SH "DESCRIPTION" +This command executes the command, making all gems specified in the [\fBGemfile(5)\fR][Gemfile(5)] available to \fBrequire\fR in Ruby programs\. +. +.P +Essentially, if you would normally have run something like \fBrspec spec/my_spec\.rb\fR, and you want to use the gems specified in the [\fBGemfile(5)\fR][Gemfile(5)] and installed via bundle install(1) \fIbundle\-install\.1\.html\fR, you should run \fBbundle exec rspec spec/my_spec\.rb\fR\. +. +.P +Note that \fBbundle exec\fR does not require that an executable is available on your shell\'s \fB$PATH\fR\. +. +.SH "OPTIONS" +. +.TP +\fB\-\-keep\-file\-descriptors\fR +Exec in Ruby 2\.0 began discarding non\-standard file descriptors\. When this flag is passed, exec will revert to the 1\.9 behaviour of passing all file descriptors to the new process\. +. +.SH "BUNDLE INSTALL \-\-BINSTUBS" +If you use the \fB\-\-binstubs\fR flag in bundle install(1) \fIbundle\-install\.1\.html\fR, Bundler will automatically create a directory (which defaults to \fBapp_root/bin\fR) containing all of the executables available from gems in the bundle\. +. +.P +After using \fB\-\-binstubs\fR, \fBbin/rspec spec/my_spec\.rb\fR is identical to \fBbundle exec rspec spec/my_spec\.rb\fR\. +. +.SH "ENVIRONMENT MODIFICATIONS" +\fBbundle exec\fR makes a number of changes to the shell environment, then executes the command you specify in full\. +. +.IP "\(bu" 4 +make sure that it\'s still possible to shell out to \fBbundle\fR from inside a command invoked by \fBbundle exec\fR (using \fB$BUNDLE_BIN_PATH\fR) +. +.IP "\(bu" 4 +put the directory containing executables (like \fBrails\fR, \fBrspec\fR, \fBrackup\fR) for your bundle on \fB$PATH\fR +. +.IP "\(bu" 4 +make sure that if bundler is invoked in the subshell, it uses the same \fBGemfile\fR (by setting \fBBUNDLE_GEMFILE\fR) +. +.IP "\(bu" 4 +add \fB\-rbundler/setup\fR to \fB$RUBYOPT\fR, which makes sure that Ruby programs invoked in the subshell can see the gems in the bundle +. +.IP "" 0 +. +.P +It also modifies Rubygems: +. +.IP "\(bu" 4 +disallow loading additional gems not in the bundle +. +.IP "\(bu" 4 +modify the \fBgem\fR method to be a no\-op if a gem matching the requirements is in the bundle, and to raise a \fBGem::LoadError\fR if it\'s not +. +.IP "\(bu" 4 +Define \fBGem\.refresh\fR to be a no\-op, since the source index is always frozen when using bundler, and to prevent gems from the system leaking into the environment +. +.IP "\(bu" 4 +Override \fBGem\.bin_path\fR to use the gems in the bundle, making system executables work +. +.IP "\(bu" 4 +Add all gems in the bundle into Gem\.loaded_specs +. +.IP "" 0 +. +.P +Finally, \fBbundle exec\fR also implicitly modifies \fBGemfile\.lock\fR if the lockfile and the Gemfile do not match\. Bundler needs the Gemfile to determine things such as a gem\'s groups, \fBautorequire\fR, and platforms, etc\., and that information isn\'t stored in the lockfile\. The Gemfile and lockfile must be synced in order to \fBbundle exec\fR successfully, so \fBbundle exec\fR updates the lockfile beforehand\. +. +.SS "Loading" +By default, when attempting to \fBbundle exec\fR to a file with a ruby shebang, Bundler will \fBKernel\.load\fR that file instead of using \fBKernel\.exec\fR\. For the vast majority of cases, this is a performance improvement\. In a rare few cases, this could cause some subtle side\-effects (such as dependence on the exact contents of \fB$0\fR or \fB__FILE__\fR) and the optimization can be disabled by enabling the \fBdisable_exec_load\fR setting\. +. +.SS "Shelling out" +Any Ruby code that opens a subshell (like \fBsystem\fR, backticks, or \fB%x{}\fR) will automatically use the current Bundler environment\. If you need to shell out to a Ruby command that is not part of your current bundle, use the \fBwith_clean_env\fR method with a block\. Any subshells created inside the block will be given the environment present before Bundler was activated\. For example, Homebrew commands run Ruby, but don\'t work inside a bundle: +. +.IP "" 4 +. +.nf + +Bundler\.with_clean_env do + `brew install wget` +end +. +.fi +. +.IP "" 0 +. +.P +Using \fBwith_clean_env\fR is also necessary if you are shelling out to a different bundle\. Any Bundler commands run in a subshell will inherit the current Gemfile, so commands that need to run in the context of a different bundle also need to use \fBwith_clean_env\fR\. +. +.IP "" 4 +. +.nf + +Bundler\.with_clean_env do + Dir\.chdir "/other/bundler/project" do + `bundle exec \./script` + end +end +. +.fi +. +.IP "" 0 +. +.P +Bundler provides convenience helpers that wrap \fBsystem\fR and \fBexec\fR, and they can be used like this: +. +.IP "" 4 +. +.nf + +Bundler\.clean_system(\'brew install wget\') +Bundler\.clean_exec(\'brew install wget\') +. +.fi +. +.IP "" 0 +. +.SH "RUBYGEMS PLUGINS" +At present, the Rubygems plugin system requires all files named \fBrubygems_plugin\.rb\fR on the load path of \fIany\fR installed gem when any Ruby code requires \fBrubygems\.rb\fR\. This includes executables installed into the system, like \fBrails\fR, \fBrackup\fR, and \fBrspec\fR\. +. +.P +Since Rubygems plugins can contain arbitrary Ruby code, they commonly end up activating themselves or their dependencies\. +. +.P +For instance, the \fBgemcutter 0\.5\fR gem depended on \fBjson_pure\fR\. If you had that version of gemcutter installed (even if you \fIalso\fR had a newer version without this problem), Rubygems would activate \fBgemcutter 0\.5\fR and \fBjson_pure <latest>\fR\. +. +.P +If your Gemfile(5) also contained \fBjson_pure\fR (or a gem with a dependency on \fBjson_pure\fR), the latest version on your system might conflict with the version in your Gemfile(5), or the snapshot version in your \fBGemfile\.lock\fR\. +. +.P +If this happens, bundler will say: +. +.IP "" 4 +. +.nf + +You have already activated json_pure 1\.4\.6 but your Gemfile +requires json_pure 1\.4\.3\. Consider using bundle exec\. +. +.fi +. +.IP "" 0 +. +.P +In this situation, you almost certainly want to remove the underlying gem with the problematic gem plugin\. In general, the authors of these plugins (in this case, the \fBgemcutter\fR gem) have released newer versions that are more careful in their plugins\. +. +.P +You can find a list of all the gems containing gem plugins by running +. +.IP "" 4 +. +.nf + +ruby \-rubygems \-e "puts Gem\.find_files(\'rubygems_plugin\.rb\')" +. +.fi +. +.IP "" 0 +. +.P +At the very least, you should remove all but the newest version of each gem plugin, and also remove all gem plugins that you aren\'t using (\fBgem uninstall gem_name\fR)\. diff --git a/man/bundle-exec.1.txt b/man/bundle-exec.1.txt new file mode 100644 index 0000000000..9494d9f6ad --- /dev/null +++ b/man/bundle-exec.1.txt @@ -0,0 +1,178 @@ +BUNDLE-EXEC(1) BUNDLE-EXEC(1) + + + +1mNAME0m + 1mbundle-exec 22m- Execute a command in the context of the bundle + +1mSYNOPSIS0m + 1mbundle exec 22m[--keep-file-descriptors] 4mcommand0m + +1mDESCRIPTION0m + This command executes the command, making all gems specified in the + [1mGemfile(5)22m][Gemfile(5)] available to 1mrequire 22min Ruby programs. + + Essentially, if you would normally have run something like 1mrspec0m + 1mspec/my_spec.rb22m, and you want to use the gems specified in the [1mGem-0m + 1mfile(5)22m][Gemfile(5)] and installed via bundle install(1) 4mbun-0m + 4mdle-install.1.html24m, you should run 1mbundle exec rspec spec/my_spec.rb22m. + + Note that 1mbundle exec 22mdoes not require that an executable is available + on your shell's 1m$PATH22m. + +1mOPTIONS0m + 1m--keep-file-descriptors0m + Exec in Ruby 2.0 began discarding non-standard file descriptors. + When this flag is passed, exec will revert to the 1.9 behaviour + of passing all file descriptors to the new process. + +1mBUNDLE INSTALL --BINSTUBS0m + If you use the 1m--binstubs 22mflag in bundle install(1) 4mbun-0m + 4mdle-install.1.html24m, Bundler will automatically create a directory + (which defaults to 1mapp_root/bin22m) containing all of the executables + available from gems in the bundle. + + After using 1m--binstubs22m, 1mbin/rspec spec/my_spec.rb 22mis identical to 1mbun-0m + 1mdle exec rspec spec/my_spec.rb22m. + +1mENVIRONMENT MODIFICATIONS0m + 1mbundle exec 22mmakes a number of changes to the shell environment, then + executes the command you specify in full. + + o make sure that it's still possible to shell out to 1mbundle 22mfrom + inside a command invoked by 1mbundle exec 22m(using 1m$BUNDLE_BIN_PATH22m) + + o put the directory containing executables (like 1mrails22m, 1mrspec22m, + 1mrackup22m) for your bundle on 1m$PATH0m + + o make sure that if bundler is invoked in the subshell, it uses the + same 1mGemfile 22m(by setting 1mBUNDLE_GEMFILE22m) + + o add 1m-rbundler/setup 22mto 1m$RUBYOPT22m, which makes sure that Ruby pro- + grams invoked in the subshell can see the gems in the bundle + + + + It also modifies Rubygems: + + o disallow loading additional gems not in the bundle + + o modify the 1mgem 22mmethod to be a no-op if a gem matching the require- + ments is in the bundle, and to raise a 1mGem::LoadError 22mif it's not + + o Define 1mGem.refresh 22mto be a no-op, since the source index is always + frozen when using bundler, and to prevent gems from the system + leaking into the environment + + o Override 1mGem.bin_path 22mto use the gems in the bundle, making system + executables work + + o Add all gems in the bundle into Gem.loaded_specs + + + + Finally, 1mbundle exec 22malso implicitly modifies 1mGemfile.lock 22mif the lock- + file and the Gemfile do not match. Bundler needs the Gemfile to deter- + mine things such as a gem's groups, 1mautorequire22m, and platforms, etc., + and that information isn't stored in the lockfile. The Gemfile and + lockfile must be synced in order to 1mbundle exec 22msuccessfully, so 1mbundle0m + 1mexec 22mupdates the lockfile beforehand. + + 1mLoading0m + By default, when attempting to 1mbundle exec 22mto a file with a ruby she- + bang, Bundler will 1mKernel.load 22mthat file instead of using 1mKernel.exec22m. + For the vast majority of cases, this is a performance improvement. In a + rare few cases, this could cause some subtle side-effects (such as + dependence on the exact contents of 1m$0 22mor 1m__FILE__22m) and the optimiza- + tion can be disabled by enabling the 1mdisable_exec_load 22msetting. + + 1mShelling out0m + Any Ruby code that opens a subshell (like 1msystem22m, backticks, or 1m%x{}22m) + will automatically use the current Bundler environment. If you need to + shell out to a Ruby command that is not part of your current bundle, + use the 1mwith_clean_env 22mmethod with a block. Any subshells created + inside the block will be given the environment present before Bundler + was activated. For example, Homebrew commands run Ruby, but don't work + inside a bundle: + + + + Bundler.with_clean_env do + `brew install wget` + end + + + + Using 1mwith_clean_env 22mis also necessary if you are shelling out to a + different bundle. Any Bundler commands run in a subshell will inherit + the current Gemfile, so commands that need to run in the context of a + different bundle also need to use 1mwith_clean_env22m. + + + + Bundler.with_clean_env do + Dir.chdir "/other/bundler/project" do + `bundle exec ./script` + end + end + + + + Bundler provides convenience helpers that wrap 1msystem 22mand 1mexec22m, and + they can be used like this: + + + + Bundler.clean_system('brew install wget') + Bundler.clean_exec('brew install wget') + + + +1mRUBYGEMS PLUGINS0m + At present, the Rubygems plugin system requires all files named + 1mrubygems_plugin.rb 22mon the load path of 4many24m installed gem when any Ruby + code requires 1mrubygems.rb22m. This includes executables installed into the + system, like 1mrails22m, 1mrackup22m, and 1mrspec22m. + + Since Rubygems plugins can contain arbitrary Ruby code, they commonly + end up activating themselves or their dependencies. + + For instance, the 1mgemcutter 0.5 22mgem depended on 1mjson_pure22m. If you had + that version of gemcutter installed (even if you 4malso24m had a newer ver- + sion without this problem), Rubygems would activate 1mgemcutter 0.5 22mand + 1mjson_pure <latest>22m. + + If your Gemfile(5) also contained 1mjson_pure 22m(or a gem with a dependency + on 1mjson_pure22m), the latest version on your system might conflict with + the version in your Gemfile(5), or the snapshot version in your 1mGem-0m + 1mfile.lock22m. + + If this happens, bundler will say: + + + + You have already activated json_pure 1.4.6 but your Gemfile + requires json_pure 1.4.3. Consider using bundle exec. + + + + In this situation, you almost certainly want to remove the underlying + gem with the problematic gem plugin. In general, the authors of these + plugins (in this case, the 1mgemcutter 22mgem) have released newer versions + that are more careful in their plugins. + + You can find a list of all the gems containing gem plugins by running + + + + ruby -rubygems -e "puts Gem.find_files('rubygems_plugin.rb')" + + + + At the very least, you should remove all but the newest version of each + gem plugin, and also remove all gem plugins that you aren't using (1mgem0m + 1muninstall gem_name22m). + + + + October 2018 BUNDLE-EXEC(1) diff --git a/man/bundle-exec.ronn b/man/bundle-exec.ronn new file mode 100644 index 0000000000..aa680f4c5d --- /dev/null +++ b/man/bundle-exec.ronn @@ -0,0 +1,152 @@ +bundle-exec(1) -- Execute a command in the context of the bundle +================================================================ + +## SYNOPSIS + +`bundle exec` [--keep-file-descriptors] <command> + +## DESCRIPTION + +This command executes the command, making all gems specified in the +[`Gemfile(5)`][Gemfile(5)] available to `require` in Ruby programs. + +Essentially, if you would normally have run something like +`rspec spec/my_spec.rb`, and you want to use the gems specified +in the [`Gemfile(5)`][Gemfile(5)] and installed via [bundle install(1)](bundle-install.1.html), you +should run `bundle exec rspec spec/my_spec.rb`. + +Note that `bundle exec` does not require that an executable is +available on your shell's `$PATH`. + +## OPTIONS + +* `--keep-file-descriptors`: + Exec in Ruby 2.0 began discarding non-standard file descriptors. When this + flag is passed, exec will revert to the 1.9 behaviour of passing all file + descriptors to the new process. + +## BUNDLE INSTALL --BINSTUBS + +If you use the `--binstubs` flag in [bundle install(1)](bundle-install.1.html), Bundler will +automatically create a directory (which defaults to `app_root/bin`) +containing all of the executables available from gems in the bundle. + +After using `--binstubs`, `bin/rspec spec/my_spec.rb` is identical +to `bundle exec rspec spec/my_spec.rb`. + +## ENVIRONMENT MODIFICATIONS + +`bundle exec` makes a number of changes to the shell environment, +then executes the command you specify in full. + +* make sure that it's still possible to shell out to `bundle` + from inside a command invoked by `bundle exec` (using + `$BUNDLE_BIN_PATH`) +* put the directory containing executables (like `rails`, `rspec`, + `rackup`) for your bundle on `$PATH` +* make sure that if bundler is invoked in the subshell, it uses + the same `Gemfile` (by setting `BUNDLE_GEMFILE`) +* add `-rbundler/setup` to `$RUBYOPT`, which makes sure that + Ruby programs invoked in the subshell can see the gems in + the bundle + +It also modifies Rubygems: + +* disallow loading additional gems not in the bundle +* modify the `gem` method to be a no-op if a gem matching + the requirements is in the bundle, and to raise a + `Gem::LoadError` if it's not +* Define `Gem.refresh` to be a no-op, since the source + index is always frozen when using bundler, and to + prevent gems from the system leaking into the environment +* Override `Gem.bin_path` to use the gems in the bundle, + making system executables work +* Add all gems in the bundle into Gem.loaded_specs + +Finally, `bundle exec` also implicitly modifies `Gemfile.lock` if the lockfile +and the Gemfile do not match. Bundler needs the Gemfile to determine things +such as a gem's groups, `autorequire`, and platforms, etc., and that +information isn't stored in the lockfile. The Gemfile and lockfile must be +synced in order to `bundle exec` successfully, so `bundle exec` +updates the lockfile beforehand. + +### Loading + +By default, when attempting to `bundle exec` to a file with a ruby shebang, +Bundler will `Kernel.load` that file instead of using `Kernel.exec`. For the +vast majority of cases, this is a performance improvement. In a rare few cases, +this could cause some subtle side-effects (such as dependence on the exact +contents of `$0` or `__FILE__`) and the optimization can be disabled by enabling +the `disable_exec_load` setting. + +### Shelling out + +Any Ruby code that opens a subshell (like `system`, backticks, or `%x{}`) will +automatically use the current Bundler environment. If you need to shell out to +a Ruby command that is not part of your current bundle, use the +`with_clean_env` method with a block. Any subshells created inside the block +will be given the environment present before Bundler was activated. For +example, Homebrew commands run Ruby, but don't work inside a bundle: + + Bundler.with_clean_env do + `brew install wget` + end + +Using `with_clean_env` is also necessary if you are shelling out to a different +bundle. Any Bundler commands run in a subshell will inherit the current +Gemfile, so commands that need to run in the context of a different bundle also +need to use `with_clean_env`. + + Bundler.with_clean_env do + Dir.chdir "/other/bundler/project" do + `bundle exec ./script` + end + end + +Bundler provides convenience helpers that wrap `system` and `exec`, and they +can be used like this: + + Bundler.clean_system('brew install wget') + Bundler.clean_exec('brew install wget') + + +## RUBYGEMS PLUGINS + +At present, the Rubygems plugin system requires all files +named `rubygems_plugin.rb` on the load path of _any_ installed +gem when any Ruby code requires `rubygems.rb`. This includes +executables installed into the system, like `rails`, `rackup`, +and `rspec`. + +Since Rubygems plugins can contain arbitrary Ruby code, they +commonly end up activating themselves or their dependencies. + +For instance, the `gemcutter 0.5` gem depended on `json_pure`. +If you had that version of gemcutter installed (even if +you _also_ had a newer version without this problem), Rubygems +would activate `gemcutter 0.5` and `json_pure <latest>`. + +If your Gemfile(5) also contained `json_pure` (or a gem +with a dependency on `json_pure`), the latest version on +your system might conflict with the version in your +Gemfile(5), or the snapshot version in your `Gemfile.lock`. + +If this happens, bundler will say: + + You have already activated json_pure 1.4.6 but your Gemfile + requires json_pure 1.4.3. Consider using bundle exec. + +In this situation, you almost certainly want to remove the +underlying gem with the problematic gem plugin. In general, +the authors of these plugins (in this case, the `gemcutter` +gem) have released newer versions that are more careful in +their plugins. + +You can find a list of all the gems containing gem plugins +by running + + ruby -rubygems -e "puts Gem.find_files('rubygems_plugin.rb')" + +At the very least, you should remove all but the newest +version of each gem plugin, and also remove all gem plugins +that you aren't using (`gem uninstall gem_name`). diff --git a/man/bundle-gem.1 b/man/bundle-gem.1 new file mode 100644 index 0000000000..9aa6183240 --- /dev/null +++ b/man/bundle-gem.1 @@ -0,0 +1,80 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BUNDLE\-GEM" "1" "October 2018" "" "" +. +.SH "NAME" +\fBbundle\-gem\fR \- Generate a project skeleton for creating a rubygem +. +.SH "SYNOPSIS" +\fBbundle gem\fR \fIGEM_NAME\fR \fIOPTIONS\fR +. +.SH "DESCRIPTION" +Generates a directory named \fBGEM_NAME\fR with a \fBRakefile\fR, \fBGEM_NAME\.gemspec\fR, and other supporting files and directories that can be used to develop a rubygem with that name\. +. +.P +Run \fBrake \-T\fR in the resulting project for a list of Rake tasks that can be used to test and publish the gem to rubygems\.org\. +. +.P +The generated project skeleton can be customized with OPTIONS, as explained below\. Note that these options can also be specified via Bundler\'s global configuration file using the following names: +. +.IP "\(bu" 4 +\fBgem\.coc\fR +. +.IP "\(bu" 4 +\fBgem\.mit\fR +. +.IP "\(bu" 4 +\fBgem\.test\fR +. +.IP "" 0 +. +.SH "OPTIONS" +. +.TP +\fB\-\-exe\fR or \fB\-b\fR or \fB\-\-bin\fR +Specify that Bundler should create a binary executable (as \fBexe/GEM_NAME\fR) in the generated rubygem project\. This binary will also be added to the \fBGEM_NAME\.gemspec\fR manifest\. This behavior is disabled by default\. +. +.TP +\fB\-\-no\-exe\fR +Do not create a binary (overrides \fB\-\-exe\fR specified in the global config)\. +. +.TP +\fB\-\-coc\fR +Add a \fBCODE_OF_CONDUCT\.md\fR file to the root of the generated project\. If this option is unspecified, an interactive prompt will be displayed and the answer will be saved in Bundler\'s global config for future \fBbundle gem\fR use\. +. +.TP +\fB\-\-no\-coc\fR +Do not create a \fBCODE_OF_CONDUCT\.md\fR (overrides \fB\-\-coc\fR specified in the global config)\. +. +.TP +\fB\-\-ext\fR +Add boilerplate for C extension code to the generated project\. This behavior is disabled by default\. +. +.TP +\fB\-\-no\-ext\fR +Do not add C extension code (overrides \fB\-\-ext\fR specified in the global config)\. +. +.TP +\fB\-\-mit\fR +Add an MIT license to a \fBLICENSE\.txt\fR file in the root of the generated project\. Your name from the global git config is used for the copyright statement\. If this option is unspecified, an interactive prompt will be displayed and the answer will be saved in Bundler\'s global config for future \fBbundle gem\fR use\. +. +.TP +\fB\-\-no\-mit\fR +Do not create a \fBLICENSE\.txt\fR (overrides \fB\-\-mit\fR specified in the global config)\. +. +.TP +\fB\-t\fR, \fB\-\-test=minitest\fR, \fB\-\-test=rspec\fR +Specify the test framework that Bundler should use when generating the project\. Acceptable values are \fBminitest\fR and \fBrspec\fR\. The \fBGEM_NAME\.gemspec\fR will be configured and a skeleton test/spec directory will be created based on this option\. If this option is unspecified, an interactive prompt will be displayed and the answer will be saved in Bundler\'s global config for future \fBbundle gem\fR use\. If no option is specified, the default testing framework is RSpec\. +. +.TP +\fB\-e\fR, \fB\-\-edit[=EDITOR]\fR +Open the resulting GEM_NAME\.gemspec in EDITOR, or the default editor if not specified\. The default is \fB$BUNDLER_EDITOR\fR, \fB$VISUAL\fR, or \fB$EDITOR\fR\. +. +.SH "SEE ALSO" +. +.IP "\(bu" 4 +bundle config(1) \fIbundle\-config\.1\.html\fR +. +.IP "" 0 + diff --git a/man/bundle-gem.1.txt b/man/bundle-gem.1.txt new file mode 100644 index 0000000000..762fc35ae9 --- /dev/null +++ b/man/bundle-gem.1.txt @@ -0,0 +1,91 @@ +BUNDLE-GEM(1) BUNDLE-GEM(1) + + + +1mNAME0m + 1mbundle-gem 22m- Generate a project skeleton for creating a rubygem + +1mSYNOPSIS0m + 1mbundle gem 4m22mGEM_NAME24m 4mOPTIONS0m + +1mDESCRIPTION0m + Generates a directory named 1mGEM_NAME 22mwith a 1mRakefile22m, 1mGEM_NAME.gemspec22m, + and other supporting files and directories that can be used to develop + a rubygem with that name. + + Run 1mrake -T 22min the resulting project for a list of Rake tasks that can + be used to test and publish the gem to rubygems.org. + + The generated project skeleton can be customized with OPTIONS, as + explained below. Note that these options can also be specified via + Bundler's global configuration file using the following names: + + o 1mgem.coc0m + + o 1mgem.mit0m + + o 1mgem.test0m + + + +1mOPTIONS0m + 1m--exe 22mor 1m-b 22mor 1m--bin0m + Specify that Bundler should create a binary executable (as + 1mexe/GEM_NAME22m) in the generated rubygem project. This binary will + also be added to the 1mGEM_NAME.gemspec 22mmanifest. This behavior is + disabled by default. + + 1m--no-exe0m + Do not create a binary (overrides 1m--exe 22mspecified in the global + config). + + 1m--coc 22mAdd a 1mCODE_OF_CONDUCT.md 22mfile to the root of the generated + project. If this option is unspecified, an interactive prompt + will be displayed and the answer will be saved in Bundler's + global config for future 1mbundle gem 22muse. + + 1m--no-coc0m + Do not create a 1mCODE_OF_CONDUCT.md 22m(overrides 1m--coc 22mspecified in + the global config). + + 1m--ext 22mAdd boilerplate for C extension code to the generated project. + This behavior is disabled by default. + + 1m--no-ext0m + Do not add C extension code (overrides 1m--ext 22mspecified in the + global config). + + 1m--mit 22mAdd an MIT license to a 1mLICENSE.txt 22mfile in the root of the gen- + erated project. Your name from the global git config is used for + the copyright statement. If this option is unspecified, an + interactive prompt will be displayed and the answer will be + saved in Bundler's global config for future 1mbundle gem 22muse. + + 1m--no-mit0m + Do not create a 1mLICENSE.txt 22m(overrides 1m--mit 22mspecified in the + global config). + + 1m-t22m, 1m--test=minitest22m, 1m--test=rspec0m + Specify the test framework that Bundler should use when generat- + ing the project. Acceptable values are 1mminitest 22mand 1mrspec22m. The + 1mGEM_NAME.gemspec 22mwill be configured and a skeleton test/spec + directory will be created based on this option. If this option + is unspecified, an interactive prompt will be displayed and the + answer will be saved in Bundler's global config for future 1mbun-0m + 1mdle gem 22muse. If no option is specified, the default testing + framework is RSpec. + + 1m-e22m, 1m--edit[=EDITOR]0m + Open the resulting GEM_NAME.gemspec in EDITOR, or the default + editor if not specified. The default is 1m$BUNDLER_EDITOR22m, 1m$VIS-0m + 1mUAL22m, or 1m$EDITOR22m. + +1mSEE ALSO0m + o bundle config(1) 4mbundle-config.1.html0m + + + + + + + October 2018 BUNDLE-GEM(1) diff --git a/man/bundle-gem.ronn b/man/bundle-gem.ronn new file mode 100644 index 0000000000..cf3d037df2 --- /dev/null +++ b/man/bundle-gem.ronn @@ -0,0 +1,78 @@ +bundle-gem(1) -- Generate a project skeleton for creating a rubygem +==================================================================== + +## SYNOPSIS + +`bundle gem` <GEM_NAME> [OPTIONS] + +## DESCRIPTION + +Generates a directory named `GEM_NAME` with a `Rakefile`, `GEM_NAME.gemspec`, +and other supporting files and directories that can be used to develop a +rubygem with that name. + +Run `rake -T` in the resulting project for a list of Rake tasks that can be used +to test and publish the gem to rubygems.org. + +The generated project skeleton can be customized with OPTIONS, as explained +below. Note that these options can also be specified via Bundler's global +configuration file using the following names: + +* `gem.coc` +* `gem.mit` +* `gem.test` + +## OPTIONS + +* `--exe` or `-b` or `--bin`: + Specify that Bundler should create a binary executable (as `exe/GEM_NAME`) + in the generated rubygem project. This binary will also be added to the + `GEM_NAME.gemspec` manifest. This behavior is disabled by default. + +* `--no-exe`: + Do not create a binary (overrides `--exe` specified in the global config). + +* `--coc`: + Add a `CODE_OF_CONDUCT.md` file to the root of the generated project. If + this option is unspecified, an interactive prompt will be displayed and the + answer will be saved in Bundler's global config for future `bundle gem` use. + +* `--no-coc`: + Do not create a `CODE_OF_CONDUCT.md` (overrides `--coc` specified in the + global config). + +* `--ext`: + Add boilerplate for C extension code to the generated project. This behavior + is disabled by default. + +* `--no-ext`: + Do not add C extension code (overrides `--ext` specified in the global + config). + +* `--mit`: + Add an MIT license to a `LICENSE.txt` file in the root of the generated + project. Your name from the global git config is used for the copyright + statement. If this option is unspecified, an interactive prompt will be + displayed and the answer will be saved in Bundler's global config for future + `bundle gem` use. + +* `--no-mit`: + Do not create a `LICENSE.txt` (overrides `--mit` specified in the global + config). + +* `-t`, `--test=minitest`, `--test=rspec`: + Specify the test framework that Bundler should use when generating the + project. Acceptable values are `minitest` and `rspec`. The `GEM_NAME.gemspec` + will be configured and a skeleton test/spec directory will be created based + on this option. If this option is unspecified, an interactive prompt will be + displayed and the answer will be saved in Bundler's global config for future + `bundle gem` use. + If no option is specified, the default testing framework is RSpec. + +* `-e`, `--edit[=EDITOR]`: + Open the resulting GEM_NAME.gemspec in EDITOR, or the default editor if not + specified. The default is `$BUNDLER_EDITOR`, `$VISUAL`, or `$EDITOR`. + +## SEE ALSO + +* [bundle config(1)](bundle-config.1.html) diff --git a/man/bundle-info.1 b/man/bundle-info.1 new file mode 100644 index 0000000000..d04fa24a91 --- /dev/null +++ b/man/bundle-info.1 @@ -0,0 +1,20 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BUNDLE\-INFO" "1" "May 2018" "" "" +. +.SH "NAME" +\fBbundle\-info\fR \- Show information for the given gem in your bundle +. +.SH "SYNOPSIS" +\fBbundle info\fR [GEM] [\-\-path] +. +.SH "DESCRIPTION" +Print the basic information about the provided GEM such as homepage, version, path and summary\. +. +.SH "OPTIONS" +. +.TP +\fB\-\-path\fR +Print the path of the given gem + diff --git a/man/bundle-info.1.txt b/man/bundle-info.1.txt new file mode 100644 index 0000000000..022e8d84ff --- /dev/null +++ b/man/bundle-info.1.txt @@ -0,0 +1,21 @@ +BUNDLE-INFO(1) BUNDLE-INFO(1) + + + +1mNAME0m + 1mbundle-info 22m- Show information for the given gem in your bundle + +1mSYNOPSIS0m + 1mbundle info 22m[GEM] [--path] + +1mDESCRIPTION0m + Print the basic information about the provided GEM such as homepage, + version, path and summary. + +1mOPTIONS0m + 1m--path 22mPrint the path of the given gem + + + + + May 2018 BUNDLE-INFO(1) diff --git a/man/bundle-info.ronn b/man/bundle-info.ronn new file mode 100644 index 0000000000..47e457aa3c --- /dev/null +++ b/man/bundle-info.ronn @@ -0,0 +1,17 @@ +bundle-info(1) -- Show information for the given gem in your bundle +========================================================================= + +## SYNOPSIS + +`bundle info` [GEM] + [--path] + +## DESCRIPTION + +Print the basic information about the provided GEM such as homepage, version, +path and summary. + +## OPTIONS + +* `--path`: +Print the path of the given gem diff --git a/man/bundle-init.1 b/man/bundle-init.1 new file mode 100644 index 0000000000..6f80b1c68d --- /dev/null +++ b/man/bundle-init.1 @@ -0,0 +1,25 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BUNDLE\-INIT" "1" "June 2018" "" "" +. +.SH "NAME" +\fBbundle\-init\fR \- Generates a Gemfile into the current working directory +. +.SH "SYNOPSIS" +\fBbundle init\fR [\-\-gemspec=FILE] +. +.SH "DESCRIPTION" +Init generates a default [\fBGemfile(5)\fR][Gemfile(5)] in the current working directory\. When adding a [\fBGemfile(5)\fR][Gemfile(5)] to a gem with a gemspec, the \fB\-\-gemspec\fR option will automatically add each dependency listed in the gemspec file to the newly created [\fBGemfile(5)\fR][Gemfile(5)]\. +. +.SH "OPTIONS" +. +.TP +\fB\-\-gemspec\fR +Use the specified \.gemspec to create the [\fBGemfile(5)\fR][Gemfile(5)] +. +.SH "FILES" +Included in the default [\fBGemfile(5)\fR][Gemfile(5)] generated is the line \fB# frozen_string_literal: true\fR\. This is a magic comment supported for the first time in Ruby 2\.3\. The presence of this line results in all string literals in the file being implicitly frozen\. +. +.SH "SEE ALSO" +Gemfile(5) \fIhttp://bundler\.io/man/gemfile\.5\.html\fR diff --git a/man/bundle-init.1.txt b/man/bundle-init.1.txt new file mode 100644 index 0000000000..3c34dafc47 --- /dev/null +++ b/man/bundle-init.1.txt @@ -0,0 +1,34 @@ +BUNDLE-INIT(1) BUNDLE-INIT(1) + + + +1mNAME0m + 1mbundle-init 22m- Generates a Gemfile into the current working directory + +1mSYNOPSIS0m + 1mbundle init 22m[--gemspec=FILE] + +1mDESCRIPTION0m + Init generates a default [1mGemfile(5)22m][Gemfile(5)] in the current work- + ing directory. When adding a [1mGemfile(5)22m][Gemfile(5)] to a gem with a + gemspec, the 1m--gemspec 22moption will automatically add each dependency + listed in the gemspec file to the newly created [1mGemfile(5)22m][Gem- + file(5)]. + +1mOPTIONS0m + 1m--gemspec0m + Use the specified .gemspec to create the [1mGemfile(5)22m][Gem- + file(5)] + +1mFILES0m + Included in the default [1mGemfile(5)22m][Gemfile(5)] generated is the line + 1m# frozen_string_literal: true22m. This is a magic comment supported for + the first time in Ruby 2.3. The presence of this line results in all + string literals in the file being implicitly frozen. + +1mSEE ALSO0m + Gemfile(5) 4mhttp://bundler.io/man/gemfile.5.html0m + + + + June 2018 BUNDLE-INIT(1) diff --git a/man/bundle-init.ronn b/man/bundle-init.ronn new file mode 100644 index 0000000000..7504af7bab --- /dev/null +++ b/man/bundle-init.ronn @@ -0,0 +1,29 @@ +bundle-init(1) -- Generates a Gemfile into the current working directory +======================================================================== + +## SYNOPSIS + +`bundle init` [--gemspec=FILE] + +## DESCRIPTION + +Init generates a default [`Gemfile(5)`][Gemfile(5)] in the current working directory. When +adding a [`Gemfile(5)`][Gemfile(5)] to a gem with a gemspec, the `--gemspec` option will +automatically add each dependency listed in the gemspec file to the newly +created [`Gemfile(5)`][Gemfile(5)]. + +## OPTIONS + +* `--gemspec`: + Use the specified .gemspec to create the [`Gemfile(5)`][Gemfile(5)] + +## FILES + +Included in the default [`Gemfile(5)`][Gemfile(5)] +generated is the line `# frozen_string_literal: true`. This is a magic comment +supported for the first time in Ruby 2.3. The presence of this line +results in all string literals in the file being implicitly frozen. + +## SEE ALSO + +[Gemfile(5)](http://bundler.io/man/gemfile.5.html) diff --git a/man/bundle-inject.1 b/man/bundle-inject.1 new file mode 100644 index 0000000000..3c66ff8dce --- /dev/null +++ b/man/bundle-inject.1 @@ -0,0 +1,33 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BUNDLE\-INJECT" "1" "June 2018" "" "" +. +.SH "NAME" +\fBbundle\-inject\fR \- Add named gem(s) with version requirements to Gemfile +. +.SH "SYNOPSIS" +\fBbundle inject\fR [GEM] [VERSION] +. +.SH "DESCRIPTION" +Adds the named gem(s) with their version requirements to the resolved [\fBGemfile(5)\fR][Gemfile(5)]\. +. +.P +This command will add the gem to both your [\fBGemfile(5)\fR][Gemfile(5)] and Gemfile\.lock if it isn\'t listed yet\. +. +.P +Example: +. +.IP "" 4 +. +.nf + +bundle install +bundle inject \'rack\' \'> 0\' +. +.fi +. +.IP "" 0 +. +.P +This will inject the \'rack\' gem with a version greater than 0 in your [\fBGemfile(5)\fR][Gemfile(5)] and Gemfile\.lock diff --git a/man/bundle-inject.1.txt b/man/bundle-inject.1.txt new file mode 100644 index 0000000000..e7fba5d517 --- /dev/null +++ b/man/bundle-inject.1.txt @@ -0,0 +1,32 @@ +BUNDLE-INJECT(1) BUNDLE-INJECT(1) + + + +1mNAME0m + 1mbundle-inject 22m- Add named gem(s) with version requirements to Gemfile + +1mSYNOPSIS0m + 1mbundle inject 22m[GEM] [VERSION] + +1mDESCRIPTION0m + Adds the named gem(s) with their version requirements to the resolved + [1mGemfile(5)22m][Gemfile(5)]. + + This command will add the gem to both your [1mGemfile(5)22m][Gemfile(5)] and + Gemfile.lock if it isn't listed yet. + + Example: + + + + bundle install + bundle inject 'rack' '> 0' + + + + This will inject the 'rack' gem with a version greater than 0 in your + [1mGemfile(5)22m][Gemfile(5)] and Gemfile.lock + + + + June 2018 BUNDLE-INJECT(1) diff --git a/man/bundle-inject.ronn b/man/bundle-inject.ronn new file mode 100644 index 0000000000..f454341896 --- /dev/null +++ b/man/bundle-inject.ronn @@ -0,0 +1,22 @@ +bundle-inject(1) -- Add named gem(s) with version requirements to Gemfile +========================================================================= + +## SYNOPSIS + +`bundle inject` [GEM] [VERSION] + +## DESCRIPTION + +Adds the named gem(s) with their version requirements to the resolved +[`Gemfile(5)`][Gemfile(5)]. + +This command will add the gem to both your [`Gemfile(5)`][Gemfile(5)] and Gemfile.lock if it +isn't listed yet. + +Example: + + bundle install + bundle inject 'rack' '> 0' + +This will inject the 'rack' gem with a version greater than 0 in your +[`Gemfile(5)`][Gemfile(5)] and Gemfile.lock diff --git a/man/bundle-install.1 b/man/bundle-install.1 new file mode 100644 index 0000000000..6026713af1 --- /dev/null +++ b/man/bundle-install.1 @@ -0,0 +1,311 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BUNDLE\-INSTALL" "1" "October 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\.\.\.]] +. +.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\. +. +.P +If a \fBGemfile\.lock\fR does exist, and you have not updated your Gemfile(5), Bundler will fetch all remote sources, but use the dependencies specified in the \fBGemfile\.lock\fR instead of resolving dependencies\. +. +.P +If a \fBGemfile\.lock\fR does exist, and you have updated your Gemfile(5), Bundler will use the dependencies in the \fBGemfile\.lock\fR for all gems that you did not update, but will re\-resolve the dependencies of gems that you did update\. You can find more information about this update process below under \fICONSERVATIVE UPDATING\fR\. +. +.SH "OPTIONS" +To apply any of \fB\-\-binstubs\fR, \fB\-\-deployment\fR, \fB\-\-path\fR, or \fB\-\-without\fR every time \fBbundle install\fR is run, use \fBbundle config\fR (see bundle\-config(1))\. +. +.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\. +. +.TP +\fB\-\-clean\fR +On finishing the installation Bundler is going to remove any gems not present in the current Gemfile(5)\. Don\'t worry, gems currently in use will not be removed\. +. +.TP +\fB\-\-deployment\fR +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\. +. +.TP +\fB\-\-frozen\fR +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\. +. +.TP +\fB\-\-full\-index\fR +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 seldom change by enabling this option\. +. +.TP +\fB\-\-gemfile=<gemfile>\fR +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 \fBGemfile\.lock\fR and \fBvendor/cache\fR relative to this location\. +. +.TP +\fB\-\-jobs=[<number>]\fR, \fB\-j[<number>]\fR +The maximum number of parallel download and install jobs\. The default is \fB1\fR\. +. +.TP +\fB\-\-local\fR +Do not attempt to connect to \fBrubygems\.org\fR\. Instead, Bundler will use the gems already present in Rubygems\' cache or in \fBvendor/cache\fR\. Note that if a appropriate platform\-specific gem exists on \fBrubygems\.org\fR it will not be found\. +. +.TP +\fB\-\-no\-cache\fR +Do not update the cache in \fBvendor/cache\fR with 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\. +. +.TP +\fB\-\-no\-prune\fR +Don\'t remove stale gems from the cache when the installation finishes\. +. +.TP +\fB\-\-path=<path>\fR +The location to install the specified gems to\. This defaults to Rubygems\' setting\. Bundler shares this location with Rubygems, \fBgem install \.\.\.\fR will have gem installed there, too\. Therefore, gems installed without a \fB\-\-path \.\.\.\fR setting will show up by calling \fBgem list\fR\. Accordingly, gems installed to other locations will not get listed\. +. +.TP +\fB\-\-quiet\fR +Do not print progress information to the standard output\. Instead, Bundler will exit using a status code (\fB$?\fR)\. +. +.TP +\fB\-\-retry=[<number>]\fR +Retry failed network or git requests for \fInumber\fR times\. +. +.TP +\fB\-\-shebang=<ruby\-executable>\fR +Uses the specified ruby executable (usually \fBruby\fR) to execute the scripts created with \fB\-\-binstubs\fR\. In addition, if you use \fB\-\-binstubs\fR together with \fB\-\-shebang jruby\fR these executables will be changed to execute \fBjruby\fR instead\. +. +.TP +\fB\-\-standalone[=<list>]\fR +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 \fBbundle\fR and installs the bundle there\. It also generates a \fBbundle/bundler/setup\.rb\fR file to replace Bundler\'s own setup in the manner required\. Using this option implicitly sets \fBpath\fR, which is a [remembered option][REMEMBERED OPTIONS]\. +. +.TP +\fB\-\-system\fR +Installs the gems specified in the bundle to the system\'s Rubygems location\. This overrides any previous configuration of \fB\-\-path\fR\. +. +.TP +\fB\-\-trust\-policy=[<policy>]\fR +Apply the Rubygems security policy \fIpolicy\fR, where policy is one of \fBHighSecurity\fR, \fBMediumSecurity\fR, \fBLowSecurity\fR, \fBAlmostNoSecurity\fR, or \fBNoSecurity\fR\. For more details, please see the Rubygems signing documentation linked below in \fISEE ALSO\fR\. +. +.TP +\fB\-\-with=<list>\fR +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\. +. +.TP +\fB\-\-without=<list>\fR +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\. +. +.SH "DEPLOYMENT MODE" +Bundler\'s defaults are optimized for development\. To switch to defaults optimized for deployment and for CI, use the \fB\-\-deployment\fR flag\. Do not activate deployment mode on development machines, as it will cause an error when the Gemfile(5) is modified\. +. +.IP "1." 4 +A \fBGemfile\.lock\fR is required\. +. +.IP +To ensure that the same versions of the gems you developed with and tested with are also used in deployments, a \fBGemfile\.lock\fR is required\. +. +.IP +This is mainly to ensure that you remember to check your \fBGemfile\.lock\fR into version control\. +. +.IP "2." 4 +The \fBGemfile\.lock\fR must be up to date +. +.IP +In development, you can modify your Gemfile(5) and re\-run \fBbundle install\fR to \fIconservatively update\fR your \fBGemfile\.lock\fR snapshot\. +. +.IP +In deployment, your \fBGemfile\.lock\fR should be up\-to\-date with changes made in your Gemfile(5)\. +. +.IP "3." 4 +Gems are installed to \fBvendor/bundle\fR not your default system location +. +.IP +In development, it\'s convenient to share the gems used in your application with other applications and other scripts that run on the system\. +. +.IP +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 permission to read them\. +. +.IP +As a result, \fBbundle install \-\-deployment\fR installs gems to the \fBvendor/bundle\fR directory in the application\. This may be overridden using the \fB\-\-path\fR option\. +. +.IP "" 0 +. +.SH "SUDO USAGE" +By default, Bundler installs gems to the same location as \fBgem install\fR\. +. +.P +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 \fBsudo\fR password in order to copy the gems into their system location\. +. +.P +From your perspective, this is identical to installing the gems directly into the system\. +. +.P +You should never use \fBsudo bundle install\fR\. This is because several other steps in \fBbundle install\fR must be performed as the current user: +. +.IP "\(bu" 4 +Updating your \fBGemfile\.lock\fR +. +.IP "\(bu" 4 +Updating your \fBvendor/cache\fR, if necessary +. +.IP "\(bu" 4 +Checking out private git repositories using your user\'s SSH keys +. +.IP "" 0 +. +.P +Of these three, the first two could theoretically be performed by \fBchown\fRing the resulting files to \fB$SUDO_USER\fR\. The third, however, can only be performed by invoking the \fBgit\fR command as the current user\. Therefore, git gems are downloaded and installed into \fB~/\.bundle\fR rather than $GEM_HOME or $BUNDLE_PATH\. +. +.P +As a result, you should run \fBbundle install\fR as the current user, and Bundler will ask for your password if it is needed to put the gems into their final location\. +. +.SH "INSTALLING GROUPS" +By default, \fBbundle install\fR will install all gems in all groups in your Gemfile(5), except those declared for a different platform\. +. +.P +However, you can explicitly tell Bundler to skip installing certain groups with the \fB\-\-without\fR option\. This option takes a space\-separated list of groups\. +. +.P +While the \fB\-\-without\fR option will skip \fIinstalling\fR the gems in the specified groups, it will still \fIdownload\fR those gems and use them to resolve the dependencies of every gem in your Gemfile(5)\. +. +.P +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 that you have already developed and tested against\. +. +.P +\fBBundler offers a rock\-solid guarantee that the third\-party code you are running in development and testing is also the third\-party code you are running in production\. You can choose to exclude some of that code in different environments, but you will never be caught flat\-footed by different versions of third\-party code being used in different environments\.\fR +. +.P +For a simple illustration, consider the following Gemfile(5): +. +.IP "" 4 +. +.nf + +source \'https://rubygems\.org\' + +gem \'sinatra\' + +group :production do + gem \'rack\-perftools\-profiler\' +end +. +.fi +. +.IP "" 0 +. +.P +In this case, \fBsinatra\fR depends on any version of Rack (\fB>= 1\.0\fR), while \fBrack\-perftools\-profiler\fR depends on 1\.x (\fB~> 1\.0\fR)\. +. +.P +When you run \fBbundle install \-\-without production\fR in development, we look at the dependencies of \fBrack\-perftools\-profiler\fR as 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 \fBproduction\fR group \fIis\fR used\. +. +.P +This should not cause any problems in practice, because we do not attempt to \fBinstall\fR the gems in the excluded groups, and only evaluate as part of the dependency resolution process\. +. +.P +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) radically change the gems you are using\. +. +.SH "THE GEMFILE\.LOCK" +When you run \fBbundle install\fR, 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 \fBGemfile\.lock\fR\. +. +.P +Bundler uses this file in all subsequent calls to \fBbundle install\fR, which guarantees that you always use the same exact code, even as your application moves across machines\. +. +.P +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 needed to satisfy all dependencies\. +. +.P +As a result, you \fBSHOULD\fR check your \fBGemfile\.lock\fR into 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 third\-party code being used if \fBany\fR of the gems in the Gemfile(5) or any of their dependencies have been updated\. +. +.P +When Bundler first shipped, the \fBGemfile\.lock\fR was included in the \fB\.gitignore\fR 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 \fBbundle install\fR 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\. +. +.SH "CONSERVATIVE UPDATING" +When you make a change to the Gemfile(5) and then run \fBbundle install\fR, Bundler will update only the gems that you modified\. +. +.P +In other words, if a gem that you \fBdid not modify\fR worked before you called \fBbundle install\fR, it will continue to use the exact same versions of all dependencies as it used before the update\. +. +.P +Let\'s take a look at an example\. Here\'s your original Gemfile(5): +. +.IP "" 4 +. +.nf + +source \'https://rubygems\.org\' + +gem \'actionpack\', \'2\.3\.8\' +gem \'activemerchant\' +. +.fi +. +.IP "" 0 +. +.P +In this case, both \fBactionpack\fR and \fBactivemerchant\fR depend on \fBactivesupport\fR\. The \fBactionpack\fR gem depends on \fBactivesupport 2\.3\.8\fR and \fBrack ~> 1\.1\.0\fR, while the \fBactivemerchant\fR gem depends on \fBactivesupport >= 2\.3\.2\fR, \fBbraintree >= 2\.0\.0\fR, and \fBbuilder >= 2\.0\.0\fR\. +. +.P +When the dependencies are first resolved, Bundler will select \fBactivesupport 2\.3\.8\fR, which satisfies the requirements of both gems in your Gemfile(5)\. +. +.P +Next, you modify your Gemfile(5) to: +. +.IP "" 4 +. +.nf + +source \'https://rubygems\.org\' + +gem \'actionpack\', \'3\.0\.0\.rc\' +gem \'activemerchant\' +. +.fi +. +.IP "" 0 +. +.P +The \fBactionpack 3\.0\.0\.rc\fR gem has a number of new dependencies, and updates the \fBactivesupport\fR dependency to \fB= 3\.0\.0\.rc\fR and the \fBrack\fR dependency to \fB~> 1\.2\.1\fR\. +. +.P +When you run \fBbundle install\fR, Bundler notices that you changed the \fBactionpack\fR gem, but not the \fBactivemerchant\fR gem\. It evaluates the gems currently being used to satisfy its requirements: +. +.TP +\fBactivesupport 2\.3\.8\fR +also used to satisfy a dependency in \fBactivemerchant\fR, which is not being updated +. +.TP +\fBrack ~> 1\.1\.0\fR +not currently being used to satisfy another dependency +. +.P +Because you did not explicitly ask to update \fBactivemerchant\fR, you would not expect it to suddenly stop working after updating \fBactionpack\fR\. However, satisfying the new \fBactivesupport 3\.0\.0\.rc\fR dependency of actionpack requires updating one of its dependencies\. +. +.P +Even though \fBactivemerchant\fR declares a very loose dependency that theoretically matches \fBactivesupport 3\.0\.0\.rc\fR, Bundler treats gems in your Gemfile(5) that have not changed as an atomic unit together with their dependencies\. In this case, the \fBactivemerchant\fR dependency is treated as \fBactivemerchant 1\.7\.1 + activesupport 2\.3\.8\fR, so \fBbundle install\fR will report that it cannot update \fBactionpack\fR\. +. +.P +To explicitly update \fBactionpack\fR, including its dependencies which other gems in the Gemfile(5) still depend on, run \fBbundle update actionpack\fR (see \fBbundle update(1)\fR)\. +. +.P +\fBSummary\fR: In general, after making a change to the Gemfile(5) , you should first try to run \fBbundle install\fR, 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) \fIbundle\-update\.1\.html\fR\. +. +.SH "SEE ALSO" +. +.IP "\(bu" 4 +Gem install docs \fIhttp://guides\.rubygems\.org/rubygems\-basics/#installing\-gems\fR +. +.IP "\(bu" 4 +Rubygems signing docs \fIhttp://guides\.rubygems\.org/security/\fR +. +.IP "" 0 + diff --git a/man/bundle-install.1.txt b/man/bundle-install.1.txt new file mode 100644 index 0000000000..1b7f3adcdf --- /dev/null +++ b/man/bundle-install.1.txt @@ -0,0 +1,401 @@ +BUNDLE-INSTALL(1) BUNDLE-INSTALL(1) + + + +1mNAME0m + 1mbundle-install 22m- Install the dependencies specified in your Gemfile + +1mSYNOPSIS0m + 1mbundle install 22m[--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...]]] [--sys- + tem] [--trust-policy=POLICY] [--with=GROUP[ GROUP...]] [--with- + out=GROUP[ GROUP...]] + +1mDESCRIPTION0m + Install the gems specified in your Gemfile(5). If this is the first + time you run bundle install (and a 1mGemfile.lock 22mdoes not exist), + Bundler will fetch all remote sources, resolve dependencies and install + all needed gems. + + If a 1mGemfile.lock 22mdoes exist, and you have not updated your Gemfile(5), + Bundler will fetch all remote sources, but use the dependencies speci- + fied in the 1mGemfile.lock 22minstead of resolving dependencies. + + If a 1mGemfile.lock 22mdoes exist, and you have updated your Gemfile(5), + Bundler will use the dependencies in the 1mGemfile.lock 22mfor all gems that + you did not update, but will re-resolve the dependencies of gems that + you did update. You can find more information about this update process + below under 4mCONSERVATIVE24m 4mUPDATING24m. + +1mOPTIONS0m + To apply any of 1m--binstubs22m, 1m--deployment22m, 1m--path22m, or 1m--without 22mevery + 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- + 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 + a 1mrails 22mexecutable, this flag will create a 1mbin/rails 22mexecutable + that ensures that all referred dependencies will be resolved + using the bundled gems. + + 1m--clean0m + On finishing the installation Bundler is going to remove any + gems not present in the current Gemfile(5). Don't worry, gems + currently in use will not be removed. + + 1m--deployment0m + In 4mdeployment24m 4mmode24m, Bundler will 'roll-out' the bundle for pro- + duction or CI use. Please check carefully if you want to have + this option enabled in your development environment. + + 1m--redownload0m + Force download every gem, even if the required versions are + already available locally. + + 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- + 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 + 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 + 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 + 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 + 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 + newly bundled gems from being cached during the install. + + 1m--no-prune0m + 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 + calling 1mgem list22m. Accordingly, gems installed to other locations + will not get listed. + + 1m--quiet0m + Do not print progress information to the standard output. + Instead, Bundler will exit using a status code (1m$?22m). + + 1m--retry=[<number>]0m + Retry failed network or git requests for 4mnumber24m times. + + 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 + 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 + 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 + 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 + 1m--path22m. + + 1m--trust-policy=[<policy>]0m + 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 + is removed from that list. + + 1m--without=<list>0m + 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. + +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 + 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 + required. + + 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 + 1minstall 22mto 4mconservatively24m 4mupdate24m your 1mGemfile.lock 22msnapshot. + + 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- + tion + + 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- + 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 + using the 1m--path 22moption. + + + +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 + 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 + system location. + + 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 + steps in 1mbundle install 22mmust be performed as the current user: + + o Updating your 1mGemfile.lock0m + + o Updating your 1mvendor/cache22m, if necessary + + o Checking out private git repositories using your user's SSH keys + + + + 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 + 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 + 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 + 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 + 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 + 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 + 1mdifferent versions of third-party code being used in different environ-0m + 1mments.0m + + For a simple illustration, consider the following Gemfile(5): + + + + source 'https://rubygems.org' + + gem 'sinatra' + + group :production do + gem 'rack-perftools-profiler' + end + + + + 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 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 + 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 + 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) + 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 + 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 + 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 + needed to satisfy all dependencies. + + 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 + 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 + 1mignore 22mfile 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 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, + 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 + of all dependencies as it used before the update. + + Let's take a look at an example. Here's your original Gemfile(5): + + + + source 'https://rubygems.org' + + gem 'actionpack', '2.3.8' + gem 'activemerchant' + + + + 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 + your Gemfile(5). + + Next, you modify your Gemfile(5) to: + + + + source 'https://rubygems.org' + + gem 'actionpack', '3.0.0.rc' + gem 'activemerchant' + + + + 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 + currently being used to satisfy its requirements: + + 1mactivesupport 2.3.80m + 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- + 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 + dependencies. In this case, the 1mactivemerchant 22mdependency is treated as + 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 + (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 + 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 + 4mhttp://guides.rubygems.org/rubygems-basics/#installing-gems0m + + o Rubygems signing docs 4mhttp://guides.rubygems.org/security/0m + + + + + + + October 2018 BUNDLE-INSTALL(1) diff --git a/man/bundle-install.ronn b/man/bundle-install.ronn new file mode 100644 index 0000000000..a9e375c87c --- /dev/null +++ b/man/bundle-install.ronn @@ -0,0 +1,378 @@ +bundle-install(1) -- Install the dependencies specified in your Gemfile +======================================================================= + +## SYNOPSIS + +`bundle install` [--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...]] + +## DESCRIPTION + +Install the gems specified in your Gemfile(5). If this is the first +time you run bundle install (and a `Gemfile.lock` does not exist), +Bundler will fetch all remote sources, resolve dependencies and +install all needed gems. + +If a `Gemfile.lock` does exist, and you have not updated your Gemfile(5), +Bundler will fetch all remote sources, but use the dependencies +specified in the `Gemfile.lock` instead of resolving dependencies. + +If a `Gemfile.lock` does exist, and you have updated your Gemfile(5), +Bundler will use the dependencies in the `Gemfile.lock` for all gems +that you did not update, but will re-resolve the dependencies of +gems that you did update. You can find more information about this +update process below under [CONSERVATIVE UPDATING][]. + +## OPTIONS + +To apply any of `--binstubs`, `--deployment`, `--path`, or `--without` every +time `bundle install` is run, use `bundle config` (see bundle-config(1)). + +* `--binstubs[=<directory>]`: + Creates a directory (defaults to `~/bin`) 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 `PATH` variable. For instance, if the + `rails` gem comes with a `rails` executable, this flag will create a + `bin/rails` executable that ensures that all referred dependencies will be + resolved using the bundled gems. + +* `--clean`: + On finishing the installation Bundler is going to remove any gems not present + 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 seldom change by enabling this option. + +* `--gemfile=<gemfile>`: + 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 `Gemfile.lock` and `vendor/cache` relative + to this location. + +* `--jobs=[<number>]`, `-j[<number>]`: + The maximum number of parallel download and install jobs. The default + is `1`. + +* `--local`: + Do not attempt to connect to `rubygems.org`. Instead, Bundler will use the + gems already present in Rubygems' cache or in `vendor/cache`. Note that if a + appropriate platform-specific gem exists on `rubygems.org` it will not be + found. + +* `--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 + being cached during the install. + +* `--no-prune`: + Don't remove stale gems from the cache when the installation finishes. + +* `--path=<path>`: + 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`. Accordingly, gems + installed to other locations will not get listed. + +* `--quiet`: + Do not print progress information to the standard output. Instead, Bundler + will exit using a status code (`$?`). + +* `--retry=[<number>]`: + Retry failed network or git requests for <number> times. + +* `--shebang=<ruby-executable>`: + Uses the specified ruby executable (usually `ruby`) to execute the scripts + created with `--binstubs`. In addition, if you use `--binstubs` together with + `--shebang jruby` these executables will be changed to execute `jruby` + instead. + +* `--standalone[=<list>]`: + 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 `bundle` and installs the bundle there. It + also generates a `bundle/bundler/setup.rb` file to replace Bundler's own setup + 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][]. + +* `--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 +defaults optimized for deployment and for CI, use the `--deployment` +flag. Do not activate deployment mode on development machines, as it +will cause an error when the Gemfile(5) is modified. + +1. A `Gemfile.lock` is required. + + To ensure that the same versions of the gems you developed with + and tested with are also used in deployments, a `Gemfile.lock` + is required. + + This is mainly to ensure that you remember to check your + `Gemfile.lock` into version control. + +2. The `Gemfile.lock` must be up to date + + In development, you can modify your Gemfile(5) and re-run + `bundle install` to [conservatively update][CONSERVATIVE UPDATING] + your `Gemfile.lock` snapshot. + + In deployment, your `Gemfile.lock` should be up-to-date with + changes made in your Gemfile(5). + +3. Gems are installed to `vendor/bundle` not your default system location + + 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 permission to + read them. + + As a result, `bundle install --deployment` installs gems to + the `vendor/bundle` directory in the application. This may be + overridden using the `--path` option. + +## SUDO USAGE + +By default, Bundler installs gems to the same location as `gem install`. + +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 `sudo` password in order to copy the gems into +their system location. + +From your perspective, this is identical to installing the gems +directly into the system. + +You should never use `sudo bundle install`. This is because several +other steps in `bundle install` must be performed as the current user: + +* Updating your `Gemfile.lock` +* Updating your `vendor/cache`, if necessary +* Checking out private git repositories using your user's SSH keys + +Of these three, the first two could theoretically be performed by +`chown`ing the resulting files to `$SUDO_USER`. The third, however, +can only be performed by invoking the `git` command as +the current user. Therefore, git gems are downloaded and installed +into `~/.bundle` rather than $GEM_HOME or $BUNDLE_PATH. + +As a result, you should run `bundle install` as the current user, +and Bundler will ask for your password if it is needed to put the +gems into their final location. + +## INSTALLING GROUPS + +By default, `bundle install` will 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 `--without` option. This option takes +a space-separated list of groups. + +While the `--without` option will skip _installing_ the gems in the +specified groups, it will still _download_ 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 that you have already developed and tested against. + +`Bundler offers a rock-solid guarantee that the third-party +code you are running in development and testing is also the +third-party code you are running in production. You can choose +to exclude some of that code in different environments, but you +will never be caught flat-footed by different versions of +third-party code being used in different environments.` + +For a simple illustration, consider the following Gemfile(5): + + source 'https://rubygems.org' + + gem 'sinatra' + + group :production do + gem 'rack-perftools-profiler' + end + +In this case, `sinatra` depends on any version of Rack (`>= 1.0`), while +`rack-perftools-profiler` depends on 1.x (`~> 1.0`). + +When you run `bundle install --without production` in development, we +look at the dependencies of `rack-perftools-profiler` as 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 `production` group _is_ used. + +This should not cause any problems in practice, because we do not +attempt to `install` the 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 +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) radically change the gems you are using. + +## THE GEMFILE.LOCK + +When you run `bundle install`, 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 `Gemfile.lock`. + +Bundler uses this file in all subsequent calls to `bundle install`, +which guarantees that you always use the same exact code, even +as your application moves across machines. + +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 needed to satisfy all dependencies. + +As a result, you `SHOULD` check your `Gemfile.lock` into 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 +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`, +Bundler will update only the gems that you modified. + +In other words, if a gem that you `did not modify` worked before +you called `bundle install`, 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): + + source 'https://rubygems.org' + + gem 'actionpack', '2.3.8' + gem 'activemerchant' + +In this case, both `actionpack` and `activemerchant` depend on +`activesupport`. The `actionpack` gem depends on `activesupport 2.3.8` +and `rack ~> 1.1.0`, while the `activemerchant` gem depends on +`activesupport >= 2.3.2`, `braintree >= 2.0.0`, and `builder >= 2.0.0`. + +When the dependencies are first resolved, Bundler will select +`activesupport 2.3.8`, which satisfies the requirements of both +gems in your Gemfile(5). + +Next, you modify your Gemfile(5) to: + + source 'https://rubygems.org' + + gem 'actionpack', '3.0.0.rc' + gem 'activemerchant' + +The `actionpack 3.0.0.rc` gem has a number of new dependencies, +and updates the `activesupport` dependency to `= 3.0.0.rc` and +the `rack` dependency to `~> 1.2.1`. + +When you run `bundle install`, Bundler notices that you changed +the `actionpack` gem, but not the `activemerchant` gem. It +evaluates the gems currently being used to satisfy its requirements: + + * `activesupport 2.3.8`: + also used to satisfy a dependency in `activemerchant`, + which is not being updated + * `rack ~> 1.1.0`: + not currently being used to satisfy another dependency + +Because you did not explicitly ask to update `activemerchant`, +you would not expect it to suddenly stop working after updating +`actionpack`. However, satisfying the new `activesupport 3.0.0.rc` +dependency of actionpack requires updating one of its dependencies. + +Even though `activemerchant` declares a very loose dependency +that theoretically matches `activesupport 3.0.0.rc`, Bundler treats +gems in your Gemfile(5) that have not changed as an atomic unit +together with their dependencies. In this case, the `activemerchant` +dependency is treated as `activemerchant 1.7.1 + activesupport 2.3.8`, +so `bundle install` will report that it cannot update `actionpack`. + +To explicitly update `actionpack`, including its dependencies +which other gems in the Gemfile(5) still depend on, run +`bundle update actionpack` (see `bundle update(1)`). + +`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.1.html). + +## SEE ALSO + +* [Gem install docs](http://guides.rubygems.org/rubygems-basics/#installing-gems) +* [Rubygems signing docs](http://guides.rubygems.org/security/) diff --git a/man/bundle-list.1 b/man/bundle-list.1 new file mode 100644 index 0000000000..5a8281d16b --- /dev/null +++ b/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" "October 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\. + diff --git a/man/bundle-list.1.txt b/man/bundle-list.1.txt new file mode 100644 index 0000000000..84a3cc811f --- /dev/null +++ b/man/bundle-list.1.txt @@ -0,0 +1,43 @@ +BUNDLE-LIST(1) BUNDLE-LIST(1) + + + +1mNAME0m + 1mbundle-list 22m- List all the gems in the bundle + +1mSYNOPSIS0m + 1mbundle list 22m[--name-only] [--paths] [--without-group=GROUP] + [--only-group=GROUP] + +1mDESCRIPTION0m + 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 + +1mOPTIONS0m + 1m--name-only0m + Print only the name of each gem. + + 1m--paths0m + Print the path to each gem in the bundle. + + 1m--without-group0m + Print all gems expect from a group. + + 1m--only-group0m + Print gems from a particular group. + + + + + October 2018 BUNDLE-LIST(1) diff --git a/man/bundle-list.ronn b/man/bundle-list.ronn new file mode 100644 index 0000000000..120cf5e307 --- /dev/null +++ b/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. diff --git a/man/bundle-lock.1 b/man/bundle-lock.1 new file mode 100644 index 0000000000..1a402074a7 --- /dev/null +++ b/man/bundle-lock.1 @@ -0,0 +1,84 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BUNDLE\-LOCK" "1" "October 2018" "" "" +. +.SH "NAME" +\fBbundle\-lock\fR \- Creates / Updates a lockfile without installing +. +.SH "SYNOPSIS" +\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\. +. +.SH "OPTIONS" +. +.TP +\fB\-\-update=<*gems>\fR +Ignores the existing lockfile\. Resolve then updates lockfile\. Taking a list of gems or updating all gems if no list is given\. +. +.TP +\fB\-\-local\fR +Do not attempt to connect to \fBrubygems\.org\fR\. Instead, Bundler will use the gems already present in Rubygems\' cache or in \fBvendor/cache\fR\. Note that if a appropriate platform\-specific gem exists on \fBrubygems\.org\fR it will not be found\. +. +.TP +\fB\-\-print\fR +Prints the lockfile to STDOUT instead of writing to the file system\. +. +.TP +\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\. +. +.SH "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 \fBGemfile\.lock\fR\. +. +.P +For instance, you only want to update \fBnokogiri\fR, run \fBbundle lock \-\-update nokogiri\fR\. +. +.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\. diff --git a/man/bundle-lock.1.txt b/man/bundle-lock.1.txt new file mode 100644 index 0000000000..e921040ff4 --- /dev/null +++ b/man/bundle-lock.1.txt @@ -0,0 +1,93 @@ +BUNDLE-LOCK(1) BUNDLE-LOCK(1) + + + +1mNAME0m + 1mbundle-lock 22m- Creates / Updates a lockfile without installing + +1mSYNOPSIS0m + 1mbundle lock 22m[--update] [--local] [--print] [--lockfile=PATH] + [--full-index] [--add-platform] [--remove-platform] [--patch] [--minor] + [--major] [--strict] [--conservative] + +1mDESCRIPTION0m + Lock the gems specified in Gemfile. + +1mOPTIONS0m + 1m--update=<*gems>0m + Ignores the existing lockfile. Resolve then updates lockfile. + Taking a list of gems or updating all gems if no list is given. + + 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 + exists on 1mrubygems.org 22mit will not be found. + + 1m--print0m + Prints the lockfile to STDOUT instead of writing to the file + system. + + 1m--lockfile=<path>0m + The path where the lockfile should be written to. + + 1m--full-index0m + Fall back to using the single-file index of all gems. + + 1m--add-platform0m + Add a new platform to the lockfile, re-resolving for the addi- + tion of that platform. + + 1m--remove-platform0m + Remove a platform from the lockfile. + + 1m--patch0m + If updating, prefer updating only to next patch version. + + 1m--minor0m + If updating, prefer updating only to next minor version. + + 1m--major0m + If updating, prefer updating to next major version (default). + + 1m--strict0m + If updating, do not allow any gem to be updated past latest + --patch | --minor | --major. + + 1m--conservative0m + If updating, use bundle install conservative update behavior and + do not allow shared dependencies to be updated. + +1mUPDATING ALL GEMS0m + If you run 1mbundle lock 22mwith 1m--update 22moption 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. + +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 + 1mGemfile.lock22m. + + For instance, you only want to update 1mnokogiri22m, run 1mbundle lock0m + 1m--update nokogiri22m. + + Bundler will update 1mnokogiri 22mand any of its dependencies, but leave the + rest of the gems that you specified locked to the versions in the 1mGem-0m + 1mfile.lock22m. + +1mSUPPORTING OTHER PLATFORMS0m + If you want your bundle to support platforms other than the one you're + running locally, you can run 1mbundle lock --add-platform PLATFORM 22mto 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 1mgem help platform22m. + +1mPATCH LEVEL OPTIONS0m + See bundle update(1) 4mbundle-update.1.html24m for details. + + + + October 2018 BUNDLE-LOCK(1) diff --git a/man/bundle-lock.ronn b/man/bundle-lock.ronn new file mode 100644 index 0000000000..3aa5920f5a --- /dev/null +++ b/man/bundle-lock.ronn @@ -0,0 +1,94 @@ +bundle-lock(1) -- 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 `vendor/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 addition 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 `Gemfile.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. diff --git a/man/bundle-open.1 b/man/bundle-open.1 new file mode 100644 index 0000000000..392bd6d9f2 --- /dev/null +++ b/man/bundle-open.1 @@ -0,0 +1,32 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BUNDLE\-OPEN" "1" "May 2018" "" "" +. +.SH "NAME" +\fBbundle\-open\fR \- Opens the source directory for a gem in your bundle +. +.SH "SYNOPSIS" +\fBbundle open\fR [GEM] +. +.SH "DESCRIPTION" +Opens the source directory of the provided GEM in your editor\. +. +.P +For this to work the \fBEDITOR\fR or \fBBUNDLER_EDITOR\fR environment variable has to be set\. +. +.P +Example: +. +.IP "" 4 +. +.nf + +bundle open \'rack\' +. +.fi +. +.IP "" 0 +. +.P +Will open the source directory for the \'rack\' gem in your bundle\. diff --git a/man/bundle-open.1.txt b/man/bundle-open.1.txt new file mode 100644 index 0000000000..3f067d8bde --- /dev/null +++ b/man/bundle-open.1.txt @@ -0,0 +1,29 @@ +BUNDLE-OPEN(1) BUNDLE-OPEN(1) + + + +1mNAME0m + 1mbundle-open 22m- Opens the source directory for a gem in your bundle + +1mSYNOPSIS0m + 1mbundle open 22m[GEM] + +1mDESCRIPTION0m + Opens the source directory of the provided GEM in your editor. + + For this to work the 1mEDITOR 22mor 1mBUNDLER_EDITOR 22menvironment variable has + to be set. + + Example: + + + + bundle open 'rack' + + + + Will open the source directory for the 'rack' gem in your bundle. + + + + May 2018 BUNDLE-OPEN(1) diff --git a/man/bundle-open.ronn b/man/bundle-open.ronn new file mode 100644 index 0000000000..497beac93f --- /dev/null +++ b/man/bundle-open.ronn @@ -0,0 +1,19 @@ +bundle-open(1) -- Opens the source directory for a gem in your bundle +===================================================================== + +## SYNOPSIS + +`bundle open` [GEM] + +## DESCRIPTION + +Opens the source directory of the provided GEM in your editor. + +For this to work the `EDITOR` or `BUNDLER_EDITOR` environment variable has to +be set. + +Example: + + bundle open 'rack' + +Will open the source directory for the 'rack' gem in your bundle. diff --git a/man/bundle-outdated.1 b/man/bundle-outdated.1 new file mode 100644 index 0000000000..273e029db3 --- /dev/null +++ b/man/bundle-outdated.1 @@ -0,0 +1,155 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BUNDLE\-OUTDATED" "1" "October 2018" "" "" +. +.SH "NAME" +\fBbundle\-outdated\fR \- List installed gems with newer versions available +. +.SH "SYNOPSIS" +\fBbundle outdated\fR [GEM] [\-\-local] [\-\-pre] [\-\-source] [\-\-strict] [\-\-parseable | \-\-porcelain] [\-\-group=GROUP] [\-\-groups] [\-\-update\-strict] [\-\-patch|\-\-minor|\-\-major] [\-\-filter\-major] [\-\-filter\-minor] [\-\-filter\-patch] [\-\-only\-explicit] +. +.SH "DESCRIPTION" +Outdated lists the names and versions of gems that have a newer version available in the given source\. Calling outdated with [GEM [GEM]] will only check for newer versions of the given gems\. Prerelease gems are ignored by default\. If your gems are up to date, Bundler will exit with a status of 0\. Otherwise, it will exit 1\. +. +.SH "OPTIONS" +. +.TP +\fB\-\-local\fR +Do not attempt to fetch gems remotely and use the gem cache instead\. +. +.TP +\fB\-\-pre\fR +Check for newer pre\-release gems\. +. +.TP +\fB\-\-source\fR +Check against a specific source\. +. +.TP +\fB\-\-strict\fR +Only list newer versions allowed by your Gemfile requirements\. +. +.TP +\fB\-\-parseable\fR, \fB\-\-porcelain\fR +Use minimal formatting for more parseable output\. +. +.TP +\fB\-\-group\fR +List gems from a specific group\. +. +.TP +\fB\-\-groups\fR +List gems organized by groups\. +. +.TP +\fB\-\-update\-strict\fR +Strict conservative resolution, do not allow any gem to be updated past latest \-\-patch | \-\-minor| \-\-major\. +. +.TP +\fB\-\-minor\fR +Prefer updating only to next minor version\. +. +.TP +\fB\-\-major\fR +Prefer updating to next major version (default)\. +. +.TP +\fB\-\-patch\fR +Prefer updating only to next patch version\. +. +.TP +\fB\-\-filter\-major\fR +Only list major newer versions\. +. +.TP +\fB\-\-filter\-minor\fR +Only list minor newer versions\. +. +.TP +\fB\-\-filter\-patch\fR +Only list patch newer versions\. +. +.TP +\fB\-\-only\-explicit\fR +Only list gems specified in your Gemfile, not their dependencies\. +. +.SH "PATCH LEVEL OPTIONS" +See bundle update(1) \fIbundle\-update\.1\.html\fR for details\. +. +.P +One difference between the patch level options in \fBbundle update\fR and here is the \fB\-\-strict\fR option\. \fB\-\-strict\fR was already an option on outdated before the patch level options were added\. \fB\-\-strict\fR wasn\'t altered, and the \fB\-\-update\-strict\fR option on \fBoutdated\fR reflects what \fB\-\-strict\fR does on \fBbundle update\fR\. +. +.SH "FILTERING OUTPUT" +The 3 filtering options do not affect the resolution of versions, merely what versions are shown in the output\. +. +.P +If the regular output shows the following: +. +.IP "" 4 +. +.nf + +* faker (newest 1\.6\.6, installed 1\.6\.5, requested ~> 1\.4) in groups "development, test" +* hashie (newest 3\.4\.6, installed 1\.2\.0, requested = 1\.2\.0) in groups "default" +* headless (newest 2\.3\.1, installed 2\.2\.3) in groups "test" +. +.fi +. +.IP "" 0 +. +.P +\fB\-\-filter\-major\fR would only show: +. +.IP "" 4 +. +.nf + +* hashie (newest 3\.4\.6, installed 1\.2\.0, requested = 1\.2\.0) in groups "default" +. +.fi +. +.IP "" 0 +. +.P +\fB\-\-filter\-minor\fR would only show: +. +.IP "" 4 +. +.nf + +* headless (newest 2\.3\.1, installed 2\.2\.3) in groups "test" +. +.fi +. +.IP "" 0 +. +.P +\fB\-\-filter\-patch\fR would only show: +. +.IP "" 4 +. +.nf + +* faker (newest 1\.6\.6, installed 1\.6\.5, requested ~> 1\.4) in groups "development, test" +. +.fi +. +.IP "" 0 +. +.P +Filter options can be combined\. \fB\-\-filter\-minor\fR and \fB\-\-filter\-patch\fR would show: +. +.IP "" 4 +. +.nf + +* faker (newest 1\.6\.6, installed 1\.6\.5, requested ~> 1\.4) in groups "development, test" +* headless (newest 2\.3\.1, installed 2\.2\.3) in groups "test" +. +.fi +. +.IP "" 0 +. +.P +Combining all three \fBfilter\fR options would be the same result as providing none of them\. diff --git a/man/bundle-outdated.1.txt b/man/bundle-outdated.1.txt new file mode 100644 index 0000000000..3942f19b84 --- /dev/null +++ b/man/bundle-outdated.1.txt @@ -0,0 +1,131 @@ +BUNDLE-OUTDATED(1) BUNDLE-OUTDATED(1) + + + +1mNAME0m + 1mbundle-outdated 22m- List installed gems with newer versions available + +1mSYNOPSIS0m + 1mbundle outdated 22m[GEM] [--local] [--pre] [--source] [--strict] + [--parseable | --porcelain] [--group=GROUP] [--groups] + [--update-strict] [--patch|--minor|--major] [--filter-major] [--fil- + ter-minor] [--filter-patch] [--only-explicit] + +1mDESCRIPTION0m + Outdated lists the names and versions of gems that have a newer version + available in the given source. Calling outdated with [GEM [GEM]] will + only check for newer versions of the given gems. Prerelease gems are + ignored by default. If your gems are up to date, Bundler will exit with + a status of 0. Otherwise, it will exit 1. + +1mOPTIONS0m + 1m--local0m + Do not attempt to fetch gems remotely and use the gem cache + instead. + + 1m--pre 22mCheck for newer pre-release gems. + + 1m--source0m + Check against a specific source. + + 1m--strict0m + Only list newer versions allowed by your Gemfile requirements. + + 1m--parseable22m, 1m--porcelain0m + Use minimal formatting for more parseable output. + + 1m--group0m + List gems from a specific group. + + 1m--groups0m + List gems organized by groups. + + 1m--update-strict0m + Strict conservative resolution, do not allow any gem to be + updated past latest --patch | --minor| --major. + + 1m--minor0m + Prefer updating only to next minor version. + + 1m--major0m + Prefer updating to next major version (default). + + 1m--patch0m + Prefer updating only to next patch version. + + 1m--filter-major0m + Only list major newer versions. + + 1m--filter-minor0m + Only list minor newer versions. + + 1m--filter-patch0m + Only list patch newer versions. + + 1m--only-explicit0m + Only list gems specified in your Gemfile, not their dependen- + cies. + +1mPATCH LEVEL OPTIONS0m + See bundle update(1) 4mbundle-update.1.html24m for details. + + One difference between the patch level options in 1mbundle update 22mand + here is the 1m--strict 22moption. 1m--strict 22mwas already an option on outdated + before the patch level options were added. 1m--strict 22mwasn't altered, and + the 1m--update-strict 22moption on 1moutdated 22mreflects what 1m--strict 22mdoes on + 1mbundle update22m. + +1mFILTERING OUTPUT0m + The 3 filtering options do not affect the resolution of versions, + merely what versions are shown in the output. + + If the regular output shows the following: + + + + * faker (newest 1.6.6, installed 1.6.5, requested ~> 1.4) in groups "development, test" + * hashie (newest 3.4.6, installed 1.2.0, requested = 1.2.0) in groups "default" + * headless (newest 2.3.1, installed 2.2.3) in groups "test" + + + + 1m--filter-major 22mwould only show: + + + + * hashie (newest 3.4.6, installed 1.2.0, requested = 1.2.0) in groups "default" + + + + 1m--filter-minor 22mwould only show: + + + + * headless (newest 2.3.1, installed 2.2.3) in groups "test" + + + + 1m--filter-patch 22mwould only show: + + + + * faker (newest 1.6.6, installed 1.6.5, requested ~> 1.4) in groups "development, test" + + + + Filter options can be combined. 1m--filter-minor 22mand 1m--filter-patch 22mwould + show: + + + + * faker (newest 1.6.6, installed 1.6.5, requested ~> 1.4) in groups "development, test" + * headless (newest 2.3.1, installed 2.2.3) in groups "test" + + + + Combining all three 1mfilter 22moptions would be the same result as provid- + ing none of them. + + + + October 2018 BUNDLE-OUTDATED(1) diff --git a/man/bundle-outdated.ronn b/man/bundle-outdated.ronn new file mode 100644 index 0000000000..a991d23789 --- /dev/null +++ b/man/bundle-outdated.ronn @@ -0,0 +1,111 @@ +bundle-outdated(1) -- List installed gems with newer versions available +======================================================================= + +## SYNOPSIS + +`bundle outdated` [GEM] [--local] + [--pre] + [--source] + [--strict] + [--parseable | --porcelain] + [--group=GROUP] + [--groups] + [--update-strict] + [--patch|--minor|--major] + [--filter-major] + [--filter-minor] + [--filter-patch] + [--only-explicit] + +## DESCRIPTION + +Outdated lists the names and versions of gems that have a newer version available +in the given source. Calling outdated with [GEM [GEM]] will only check for newer +versions of the given gems. Prerelease gems are ignored by default. If your gems +are up to date, Bundler will exit with a status of 0. Otherwise, it will exit 1. + +## OPTIONS + +* `--local`: + Do not attempt to fetch gems remotely and use the gem cache instead. + +* `--pre`: + Check for newer pre-release gems. + +* `--source`: + Check against a specific source. + +* `--strict`: + Only list newer versions allowed by your Gemfile requirements. + +* `--parseable`, `--porcelain`: + Use minimal formatting for more parseable output. + +* `--group`: + List gems from a specific group. + +* `--groups`: + List gems organized by groups. + +* `--update-strict`: + Strict conservative resolution, do not allow any gem to be updated past latest --patch | --minor| --major. + +* `--minor`: + Prefer updating only to next minor version. + +* `--major`: + Prefer updating to next major version (default). + +* `--patch`: + Prefer updating only to next patch version. + +* `--filter-major`: + Only list major newer versions. + +* `--filter-minor`: + Only list minor newer versions. + +* `--filter-patch`: + Only list patch newer versions. + +* `--only-explicit`: + Only list gems specified in your Gemfile, not their dependencies. + +## PATCH LEVEL OPTIONS + +See [bundle update(1)](bundle-update.1.html) for details. + +One difference between the patch level options in `bundle update` and here is the `--strict` option. +`--strict` was already an option on outdated before the patch level options were added. `--strict` +wasn't altered, and the `--update-strict` option on `outdated` reflects what `--strict` does on +`bundle update`. + +## FILTERING OUTPUT + +The 3 filtering options do not affect the resolution of versions, merely what versions are shown +in the output. + +If the regular output shows the following: + + * faker (newest 1.6.6, installed 1.6.5, requested ~> 1.4) in groups "development, test" + * hashie (newest 3.4.6, installed 1.2.0, requested = 1.2.0) in groups "default" + * headless (newest 2.3.1, installed 2.2.3) in groups "test" + +`--filter-major` would only show: + + * hashie (newest 3.4.6, installed 1.2.0, requested = 1.2.0) in groups "default" + +`--filter-minor` would only show: + + * headless (newest 2.3.1, installed 2.2.3) in groups "test" + +`--filter-patch` would only show: + + * faker (newest 1.6.6, installed 1.6.5, requested ~> 1.4) in groups "development, test" + +Filter options can be combined. `--filter-minor` and `--filter-patch` would show: + + * faker (newest 1.6.6, installed 1.6.5, requested ~> 1.4) in groups "development, test" + * headless (newest 2.3.1, installed 2.2.3) in groups "test" + +Combining all three `filter` options would be the same result as providing none of them. diff --git a/man/bundle-package.1 b/man/bundle-package.1 new file mode 100644 index 0000000000..edbf62c9f9 --- /dev/null +++ b/man/bundle-package.1 @@ -0,0 +1,55 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BUNDLE\-PACKAGE" "1" "October 2018" "" "" +. +.SH "NAME" +\fBbundle\-package\fR \- Package your needed \fB\.gem\fR files into your application +. +.SH "SYNOPSIS" +\fBbundle package\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" +Since Bundler 1\.2, 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\. +. +.SH "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 \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\. +. +.P +For instance, consider this Gemfile(5): +. +.IP "" 4 +. +.nf + +source "https://rubygems\.org" + +gem "nokogiri" +. +.fi +. +.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\. +. +.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 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\. +. +.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\. diff --git a/man/bundle-package.1.txt b/man/bundle-package.1.txt new file mode 100644 index 0000000000..cbe957333a --- /dev/null +++ b/man/bundle-package.1.txt @@ -0,0 +1,79 @@ +BUNDLE-PACKAGE(1) BUNDLE-PACKAGE(1) + + + +1mNAME0m + 1mbundle-package 22m- Package your needed 1m.gem 22mfiles into your application + +1mSYNOPSIS0m + 1mbundle package0m + +1mDESCRIPTION0m + Copy all of the 1m.gem 22mfiles needed to run the application into the 1mven-0m + 1mdor/cache 22mdirectory. In the future, when running [bundle + install(1)][bundle-install], use the gems in the cache in preference to + the ones on 1mrubygems.org22m. + +1mGIT AND PATH GEMS0m + Since Bundler 1.2, the 1mbundle package 22mcommand can also package 1m:git 22mand + 1m:path 22mdependencies besides .gem files. This needs to be explicitly + enabled via the 1m--all 22moption. Once used, the 1m--all 22moption will be + remembered. + +1mSUPPORT FOR MULTIPLE PLATFORMS0m + 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 1mven-0m + 1mdor/cache22m. This needs to be enabled via the 1m--all-platforms 22moption. + This setting will be remembered in your local bundler configuration. + +1mREMOTE FETCHING0m + By default, if you run 1mbundle install(1)22m](bundle-install.1.html) after + running bundle package(1) 4mbundle-package.1.html24m, bundler will still + connect to 1mrubygems.org 22mto check whether a platform-specific gem exists + for any of the gems in 1mvendor/cache22m. + + For instance, consider this Gemfile(5): + + + + source "https://rubygems.org" + + gem "nokogiri" + + + + If you run 1mbundle package 22munder C Ruby, bundler will retrieve the ver- + sion of 1mnokogiri 22mfor the 1m"ruby" 22mplatform. If you deploy to JRuby and + run 1mbundle install22m, bundler is forced to check to see whether a 1m"java"0m + platformed 1mnokogiri 22mexists. + + Even though the 1mnokogiri 22mgem for the Ruby platform is 4mtechnically0m + acceptable on JRuby, it has a C extension that does not run on JRuby. + As a result, bundler will, by default, still connect to 1mrubygems.org 22mto + check whether it has a version of one of your gems more specific to + your platform. + + This problem is also not limited to the 1m"java" 22mplatform. 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 1mvendor/cache 22mare appro- + priate for the platform you are on, you can run 1mbundle install --local0m + to skip checking for more appropriate gems, and use the ones in 1mven-0m + 1mdor/cache22m. + + One way to be sure that you have the right platformed versions of all + your gems is to run 1mbundle package 22mon an identical machine and check in + the gems. For instance, you can run 1mbundle package 22mon an identical + staging box during your staging process, and check in the 1mvendor/cache0m + before deploying to production. + + By default, bundle package(1) 4mbundle-package.1.html24m fetches and also + installs the gems to the default location. To package the dependencies + to 1mvendor/cache 22mwithout installing them to the local install location, + you can run 1mbundle package --no-install22m. + + + + October 2018 BUNDLE-PACKAGE(1) diff --git a/man/bundle-package.ronn b/man/bundle-package.ronn new file mode 100644 index 0000000000..bc137374da --- /dev/null +++ b/man/bundle-package.ronn @@ -0,0 +1,72 @@ +bundle-package(1) -- 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 +`vendor/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 `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 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 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 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`. diff --git a/man/bundle-platform.1 b/man/bundle-platform.1 new file mode 100644 index 0000000000..5fa4ab2cb7 --- /dev/null +++ b/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" "May 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)\. + diff --git a/man/bundle-platform.1.txt b/man/bundle-platform.1.txt new file mode 100644 index 0000000000..ad3ba0eec0 --- /dev/null +++ b/man/bundle-platform.1.txt @@ -0,0 +1,57 @@ +BUNDLE-PLATFORM(1) BUNDLE-PLATFORM(1) + + + +1mNAME0m + 1mbundle-platform 22m- Displays platform compatibility information + +1mSYNOPSIS0m + 1mbundle platform 22m[--ruby] + +1mDESCRIPTION0m + 1mplatform 22mwill 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 1mbundle platform 22mon 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. + + + + 1mplatform 22mwill list all the platforms in your 1mGemfile.lock 22mas well as + the 1mruby 22mdirective if applicable from your Gemfile(5). It will also let + you know if the 1mruby 22mdirective requirement has been met. If 1mruby 22mdirec- + tive doesn't match the running Ruby VM, it will tell you what part does + not. + +1mOPTIONS0m + 1m--ruby 22mIt will display the ruby directive information, so you don't + have to parse it from the Gemfile(5). + + + + + May 2018 BUNDLE-PLATFORM(1) diff --git a/man/bundle-platform.ronn b/man/bundle-platform.ronn new file mode 100644 index 0000000000..b5d3283fb6 --- /dev/null +++ b/man/bundle-platform.ronn @@ -0,0 +1,42 @@ +bundle-platform(1) -- 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` directive 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). diff --git a/man/bundle-pristine.1 b/man/bundle-pristine.1 new file mode 100644 index 0000000000..78a6e95fdc --- /dev/null +++ b/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" "May 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\. diff --git a/man/bundle-pristine.1.txt b/man/bundle-pristine.1.txt new file mode 100644 index 0000000000..38d6dff1c5 --- /dev/null +++ b/man/bundle-pristine.1.txt @@ -0,0 +1,44 @@ +BUNDLE-PRISTINE(1) BUNDLE-PRISTINE(1) + + + +1mNAME0m + 1mbundle-pristine 22m- Restores installed gems to their pristine condition + +1mSYNOPSIS0m + 1mbundle pristine0m + +1mDESCRIPTION0m + 1mpristine 22mrestores 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, 1mbundle pristine 22mignores unpacked files on + disk. In other words, this command utilizes the local 1m.gem 22mcache 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 + 1mpristine22m. One also cannot use 1mbundle pristine 22mon gems with a 'path' + option in the Gemfile, because bundler has no original copy it can + restore from. + + When is it practical to use 1mbundle pristine22m? + + It comes in handy when a developer is debugging a gem. 1mbundle pristine0m + is a great way to get rid of experimental changes to a gem that one may + not want. + + Why use 1mbundle pristine 22mover 1mgem pristine --all22m? + + Both commands are very similar. For context: 1mbundle pristine22m, without + arguments, cleans all gems from the lockfile. Meanwhile, 1mgem pristine0m + 1m--all 22mcleans all installed gems for that Ruby version. + + If a developer forgets which gems in their project they might have been + debugging, the Rubygems 1mgem pristine [GEMNAME] 22mcommand may be inconve- + nient. One can avoid waiting for 1mgem pristine --all22m, and instead run + 1mbundle pristine22m. + + + + May 2018 BUNDLE-PRISTINE(1) diff --git a/man/bundle-pristine.ronn b/man/bundle-pristine.ronn new file mode 100644 index 0000000000..e2d6b6a348 --- /dev/null +++ b/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`. diff --git a/man/bundle-remove.1 b/man/bundle-remove.1 new file mode 100644 index 0000000000..bbc4a4c339 --- /dev/null +++ b/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" "October 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 diff --git a/man/bundle-remove.1.txt b/man/bundle-remove.1.txt new file mode 100644 index 0000000000..1d1f74614d --- /dev/null +++ b/man/bundle-remove.1.txt @@ -0,0 +1,34 @@ +BUNDLE-REMOVE(1) BUNDLE-REMOVE(1) + + + +1mNAME0m + 1mbundle-remove 22m- Removes gems from the Gemfile + +1mSYNOPSIS0m + 1mbundle remove [GEM [GEM ...]] [--install]0m + +1mDESCRIPTION0m + 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. + +1mOPTIONS0m + 1m--install0m + Runs 1mbundle install 22mafter 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 + + + + October 2018 BUNDLE-REMOVE(1) diff --git a/man/bundle-remove.ronn b/man/bundle-remove.ronn new file mode 100644 index 0000000000..40a239b4a2 --- /dev/null +++ b/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 diff --git a/man/bundle-show.1 b/man/bundle-show.1 new file mode 100644 index 0000000000..d4a2a5c343 --- /dev/null +++ b/man/bundle-show.1 @@ -0,0 +1,23 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BUNDLE\-SHOW" "1" "October 2018" "" "" +. +.SH "NAME" +\fBbundle\-show\fR \- Shows all the gems in your bundle, or the path to a gem +. +.SH "SYNOPSIS" +\fBbundle show\fR [GEM] [\-\-paths] +. +.SH "DESCRIPTION" +Without the [GEM] option, \fBshow\fR will print a list of the names and versions of all gems that are required by your [\fBGemfile(5)\fR][Gemfile(5)], sorted by name\. +. +.P +Calling show with [GEM] will list the exact location of that gem on your machine\. +. +.SH "OPTIONS" +. +.TP +\fB\-\-paths\fR +List the paths of all gems that are required by your [\fBGemfile(5)\fR][Gemfile(5)], sorted by gem name\. + diff --git a/man/bundle-show.1.txt b/man/bundle-show.1.txt new file mode 100644 index 0000000000..e14466d3a3 --- /dev/null +++ b/man/bundle-show.1.txt @@ -0,0 +1,27 @@ +BUNDLE-SHOW(1) BUNDLE-SHOW(1) + + + +1mNAME0m + 1mbundle-show 22m- Shows all the gems in your bundle, or the path to a gem + +1mSYNOPSIS0m + 1mbundle show 22m[GEM] [--paths] + +1mDESCRIPTION0m + Without the [GEM] option, 1mshow 22mwill print a list of the names and ver- + sions of all gems that are required by your [1mGemfile(5)22m][Gemfile(5)], + sorted by name. + + Calling show with [GEM] will list the exact location of that gem on + your machine. + +1mOPTIONS0m + 1m--paths0m + List the paths of all gems that are required by your [1mGem-0m + 1mfile(5)22m][Gemfile(5)], sorted by gem name. + + + + + October 2018 BUNDLE-SHOW(1) diff --git a/man/bundle-show.ronn b/man/bundle-show.ronn new file mode 100644 index 0000000000..a6a59a1445 --- /dev/null +++ b/man/bundle-show.ronn @@ -0,0 +1,21 @@ +bundle-show(1) -- Shows all the gems in your bundle, or the path to a gem +========================================================================= + +## SYNOPSIS + +`bundle show` [GEM] + [--paths] + +## DESCRIPTION + +Without the [GEM] option, `show` will print a list of the names and versions of +all gems that are required by your [`Gemfile(5)`][Gemfile(5)], sorted by name. + +Calling show with [GEM] will list the exact location of that gem on your +machine. + +## OPTIONS + +* `--paths`: + List the paths of all gems that are required by your [`Gemfile(5)`][Gemfile(5)], + sorted by gem name. diff --git a/man/bundle-update.1 b/man/bundle-update.1 new file mode 100644 index 0000000000..49f51c09a8 --- /dev/null +++ b/man/bundle-update.1 @@ -0,0 +1,394 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BUNDLE\-UPDATE" "1" "October 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] +. +.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\. +. +.P +You would use \fBbundle update\fR to explicitly update the version of a gem\. +. +.SH "OPTIONS" +. +.TP +\fB\-\-all\fR +Update all gems specified in Gemfile\. +. +.TP +\fB\-\-group=<name>\fR, \fB\-g=[<name>]\fR +Only update the gems in the specified group\. For instance, you can update all gems in the development group with \fBbundle update \-\-group development\fR\. You can also call \fBbundle update rails \-\-group test\fR to update the rails gem and all gems in the test group, for example\. +. +.TP +\fB\-\-source=<name>\fR +The name of a \fB:git\fR or \fB:path\fR source used in the Gemfile(5)\. For instance, with a \fB:git\fR source of \fBhttp://github\.com/rails/rails\.git\fR, you would call \fBbundle update \-\-source rails\fR +. +.TP +\fB\-\-local\fR +Do not attempt to fetch gems remotely and use the gem cache instead\. +. +.TP +\fB\-\-ruby\fR +Update the locked version of Ruby to the current version of Ruby\. +. +.TP +\fB\-\-bundler\fR +Update the locked version of bundler to the invoked bundler version\. +. +.TP +\fB\-\-full\-index\fR +Fall back to using the single\-file index of all gems\. +. +.TP +\fB\-\-jobs=[<number>]\fR, \fB\-j[<number>]\fR +Specify the number of jobs to run in parallel\. The default is \fB1\fR\. +. +.TP +\fB\-\-retry=[<number>]\fR +Retry failed network or git requests for \fInumber\fR times\. +. +.TP +\fB\-\-quiet\fR +Only output warnings and errors\. +. +.TP +\fB\-\-redownload\fR +Force downloading every gem\. +. +.TP +\fB\-\-patch\fR +Prefer updating only to next patch version\. +. +.TP +\fB\-\-minor\fR +Prefer updating only to next minor version\. +. +.TP +\fB\-\-major\fR +Prefer updating to next major version (default)\. +. +.TP +\fB\-\-strict\fR +Do not allow any gem to be updated past latest \fB\-\-patch\fR | \fB\-\-minor\fR | \fB\-\-major\fR\. +. +.TP +\fB\-\-conservative\fR +Use bundle install conservative update behavior and do not allow shared dependencies to be updated\. +. +.SH "UPDATING ALL GEMS" +If you run \fBbundle update \-\-all\fR, bundler will ignore any previously installed gems and resolve all dependencies again based on the latest versions of all gems available in the sources\. +. +.P +Consider the following Gemfile(5): +. +.IP "" 4 +. +.nf + +source "https://rubygems\.org" + +gem "rails", "3\.0\.0\.rc" +gem "nokogiri" +. +.fi +. +.IP "" 0 +. +.P +When you run bundle install(1) \fIbundle\-install\.1\.html\fR the first time, bundler will resolve all of the dependencies, all the way down, and install what you need: +. +.IP "" 4 +. +.nf + +Fetching gem metadata from https://rubygems\.org/\.\.\.\.\.\.\.\.\. +Resolving dependencies\.\.\. +Installing builder 2\.1\.2 +Installing abstract 1\.0\.0 +Installing rack 1\.2\.8 +Using bundler 1\.7\.6 +Installing rake 10\.4\.0 +Installing polyglot 0\.3\.5 +Installing mime\-types 1\.25\.1 +Installing i18n 0\.4\.2 +Installing mini_portile 0\.6\.1 +Installing tzinfo 0\.3\.42 +Installing rack\-mount 0\.6\.14 +Installing rack\-test 0\.5\.7 +Installing treetop 1\.4\.15 +Installing thor 0\.14\.6 +Installing activesupport 3\.0\.0\.rc +Installing erubis 2\.6\.6 +Installing activemodel 3\.0\.0\.rc +Installing arel 0\.4\.0 +Installing mail 2\.2\.20 +Installing activeresource 3\.0\.0\.rc +Installing actionpack 3\.0\.0\.rc +Installing activerecord 3\.0\.0\.rc +Installing actionmailer 3\.0\.0\.rc +Installing railties 3\.0\.0\.rc +Installing rails 3\.0\.0\.rc +Installing nokogiri 1\.6\.5 + +Bundle complete! 2 Gemfile dependencies, 26 gems total\. +Use `bundle show [gemname]` to see where a bundled gem is installed\. +. +.fi +. +.IP "" 0 +. +.P +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 \fBGemfile\.lock\fR\. The next time you run bundle install(1) \fIbundle\-install\.1\.html\fR, bundler skips the dependency resolution and installs the same gems as it installed last time\. +. +.P +After checking in the \fBGemfile\.lock\fR into version control and cloning it on another machine, running bundle install(1) \fIbundle\-install\.1\.html\fR will \fIstill\fR install the gems that you installed last time\. You don\'t need to worry that a new release of \fBerubis\fR or \fBmail\fR changes the gems you use\. +. +.P +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 Gemfile(5)\. +. +.P +To do this, run \fBbundle update \-\-all\fR, which will ignore the \fBGemfile\.lock\fR, 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 \fBbundle update \-\-all\fR\. +. +.SH "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 \fBGemfile\.lock\fR\. +. +.P +For instance, in the scenario above, imagine that \fBnokogiri\fR releases version \fB1\.4\.4\fR, and you want to update it \fIwithout\fR updating Rails and all of its dependencies\. To do this, run \fBbundle update nokogiri\fR\. +. +.P +Bundler will update \fBnokogiri\fR and any of its dependencies, but leave alone Rails and its dependencies\. +. +.SH "OVERLAPPING DEPENDENCIES" +Sometimes, multiple gems declared in your Gemfile(5) are satisfied by the same second\-level dependency\. For instance, consider the case of \fBthin\fR and \fBrack\-perftools\-profiler\fR\. +. +.IP "" 4 +. +.nf + +source "https://rubygems\.org" + +gem "thin" +gem "rack\-perftools\-profiler" +. +.fi +. +.IP "" 0 +. +.P +The \fBthin\fR gem depends on \fBrack >= 1\.0\fR, while \fBrack\-perftools\-profiler\fR depends on \fBrack ~> 1\.0\fR\. If you run bundle install, you get: +. +.IP "" 4 +. +.nf + +Fetching source index for https://rubygems\.org/ +Installing daemons (1\.1\.0) +Installing eventmachine (0\.12\.10) with native extensions +Installing open4 (1\.0\.1) +Installing perftools\.rb (0\.4\.7) with native extensions +Installing rack (1\.2\.1) +Installing rack\-perftools_profiler (0\.0\.2) +Installing thin (1\.2\.7) with native extensions +Using bundler (1\.0\.0\.rc\.3) +. +.fi +. +.IP "" 0 +. +.P +In this case, the two gems have their own set of dependencies, but they share \fBrack\fR in common\. If you run \fBbundle update thin\fR, bundler will update \fBdaemons\fR, \fBeventmachine\fR and \fBrack\fR, which are dependencies of \fBthin\fR, but not \fBopen4\fR or \fBperftools\.rb\fR, which are dependencies of \fBrack\-perftools_profiler\fR\. Note that \fBbundle update thin\fR will update \fBrack\fR even though it\'s \fIalso\fR a dependency of \fBrack\-perftools_profiler\fR\. +. +.P +In short, by default, when you update a gem using \fBbundle update\fR, bundler will update all dependencies of that gem, including those that are also dependencies of another gem\. +. +.P +To prevent updating shared dependencies, prior to version 1\.14 the only option was the \fBCONSERVATIVE UPDATING\fR behavior in bundle install(1) \fIbundle\-install\.1\.html\fR: +. +.P +In this scenario, updating the \fBthin\fR version manually in the Gemfile(5), and then running bundle install(1) \fIbundle\-install\.1\.html\fR will only update \fBdaemons\fR and \fBeventmachine\fR, but not \fBrack\fR\. For more information, see the \fBCONSERVATIVE UPDATING\fR section of bundle install(1) \fIbundle\-install\.1\.html\fR\. +. +.P +Starting with 1\.14, specifying the \fB\-\-conservative\fR option will also prevent shared dependencies from being updated\. +. +.SH "PATCH LEVEL OPTIONS" +Version 1\.14 introduced 4 patch\-level options that will influence how gem versions are resolved\. One of the following options can be used: \fB\-\-patch\fR, \fB\-\-minor\fR or \fB\-\-major\fR\. \fB\-\-strict\fR can be added to further influence resolution\. +. +.TP +\fB\-\-patch\fR +Prefer updating only to next patch version\. +. +.TP +\fB\-\-minor\fR +Prefer updating only to next minor version\. +. +.TP +\fB\-\-major\fR +Prefer updating to next major version (default)\. +. +.TP +\fB\-\-strict\fR +Do not allow any gem to be updated past latest \fB\-\-patch\fR | \fB\-\-minor\fR | \fB\-\-major\fR\. +. +.P +When Bundler is resolving what versions to use to satisfy declared requirements in the Gemfile or in parent gems, it looks up all available versions, filters out any versions that don\'t satisfy the requirement, and then, by default, sorts them from newest to oldest, considering them in that order\. +. +.P +Providing one of the patch level options (e\.g\. \fB\-\-patch\fR) changes the sort order of the satisfying versions, causing Bundler to consider the latest \fB\-\-patch\fR or \fB\-\-minor\fR version 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\. +. +.P +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 (\fB\-\-major\fR) will be "2\.0\.0, 1\.1\.1, 1\.1\.0, 1\.0\.4, 1\.0\.3, 1\.0\.2"\. +. +.P +If the \fB\-\-patch\fR option 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"\. +. +.P +If the \fB\-\-minor\fR option 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"\. +. +.P +Combining the \fB\-\-strict\fR option 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\. +. +.P +To continue the previous example, if both \fB\-\-patch\fR and \fB\-\-strict\fR options are used, the available versions for resolution would be "1\.0\.4, 1\.0\.3, 1\.0\.2"\. If \fB\-\-minor\fR and \fB\-\-strict\fR are used, it would be "1\.1\.1, 1\.1\.0, 1\.0\.4, 1\.0\.3, 1\.0\.2"\. +. +.P +Gem requirements as defined in the Gemfile will still be the first determining factor for what versions are available\. If the gem requirement for \fBfoo\fR in the Gemfile is \'~> 1\.0\', that will accomplish the same thing as providing the \fB\-\-minor\fR and \fB\-\-strict\fR options\. +. +.SH "PATCH LEVEL EXAMPLES" +Given the following gem specifications: +. +.IP "" 4 +. +.nf + +foo 1\.4\.3, requires: ~> bar 2\.0 +foo 1\.4\.4, requires: ~> bar 2\.0 +foo 1\.4\.5, requires: ~> bar 2\.1 +foo 1\.5\.0, requires: ~> bar 2\.1 +foo 1\.5\.1, requires: ~> bar 3\.0 +bar with versions 2\.0\.3, 2\.0\.4, 2\.1\.0, 2\.1\.1, 3\.0\.0 +. +.fi +. +.IP "" 0 +. +.P +Gemfile: +. +.IP "" 4 +. +.nf + +gem \'foo\' +. +.fi +. +.IP "" 0 +. +.P +Gemfile\.lock: +. +.IP "" 4 +. +.nf + +foo (1\.4\.3) + bar (~> 2\.0) +bar (2\.0\.3) +. +.fi +. +.IP "" 0 +. +.P +Cases: +. +.IP "" 4 +. +.nf + +# Command Line Result +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +1 bundle update \-\-patch \'foo 1\.4\.5\', \'bar 2\.1\.1\' +2 bundle update \-\-patch foo \'foo 1\.4\.5\', \'bar 2\.1\.1\' +3 bundle update \-\-minor \'foo 1\.5\.1\', \'bar 3\.0\.0\' +4 bundle update \-\-minor \-\-strict \'foo 1\.5\.0\', \'bar 2\.1\.1\' +5 bundle update \-\-patch \-\-strict \'foo 1\.4\.4\', \'bar 2\.0\.4\' +. +.fi +. +.IP "" 0 +. +.P +In case 1, bar is upgraded to 2\.1\.1, a minor version increase, because the dependency from foo 1\.4\.5 required it\. +. +.P +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\. +. +.P +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\. +. +.P +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 it\'s a major increment\. +. +.P +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\. +. +.SH "RECOMMENDED WORKFLOW" +In general, when working with an application managed with bundler, you should use the following workflow: +. +.IP "\(bu" 4 +After you create your Gemfile(5) for the first time, run +. +.IP +$ bundle install +. +.IP "\(bu" 4 +Check the resulting \fBGemfile\.lock\fR into version control +. +.IP +$ git add Gemfile\.lock +. +.IP "\(bu" 4 +When checking out this repository on another development machine, run +. +.IP +$ bundle install +. +.IP "\(bu" 4 +When checking out this repository on a deployment machine, run +. +.IP +$ bundle install \-\-deployment +. +.IP "\(bu" 4 +After changing the Gemfile(5) to reflect a new or update dependency, run +. +.IP +$ bundle install +. +.IP "\(bu" 4 +Make sure to check the updated \fBGemfile\.lock\fR into version control +. +.IP +$ git add Gemfile\.lock +. +.IP "\(bu" 4 +If bundle install(1) \fIbundle\-install\.1\.html\fR reports a conflict, manually update the specific gems that you changed in the Gemfile(5) +. +.IP +$ bundle update rails thin +. +.IP "\(bu" 4 +If you want to update all the gems to the latest possible versions that still match the gems listed in the Gemfile(5), run +. +.IP +$ bundle update \-\-all +. +.IP "" 0 + diff --git a/man/bundle-update.1.txt b/man/bundle-update.1.txt new file mode 100644 index 0000000000..d2ec46444b --- /dev/null +++ b/man/bundle-update.1.txt @@ -0,0 +1,390 @@ +BUNDLE-UPDATE(1) BUNDLE-UPDATE(1) + + + +1mNAME0m + 1mbundle-update 22m- Update your gems to the latest available versions + +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] + +1mDESCRIPTION0m + Update the gems specified (all gems, if 1m--all 22mflag is used), ignoring + the previously installed gems specified in the 1mGemfile.lock22m. In gen- + eral, you should use bundle install(1) 4mbundle-install.1.html24m to install + the same exact gems and versions across machines. + + You would use 1mbundle update 22mto explicitly update the version of a gem. + +1mOPTIONS0m + 1m--all 22mUpdate all gems specified in Gemfile. + + 1m--group=<name>22m, 1m-g=[<name>]0m + Only update the gems in the specified group. For instance, you + can update all gems in the development group with 1mbundle update0m + 1m--group development22m. You can also call 1mbundle update rails0m + 1m--group test 22mto update the rails gem and all gems in the test + group, for example. + + 1m--source=<name>0m + The name of a 1m:git 22mor 1m:path 22msource used in the Gemfile(5). For + instance, with a 1m:git 22msource of + 1mhttp://github.com/rails/rails.git22m, you would call 1mbundle update0m + 1m--source rails0m + + 1m--local0m + Do not attempt to fetch gems remotely and use the gem cache + instead. + + 1m--ruby 22mUpdate the locked version of Ruby to the current version of + Ruby. + + 1m--bundler0m + Update the locked version of bundler to the invoked bundler ver- + sion. + + 1m--full-index0m + Fall back to using the single-file index of all gems. + + 1m--jobs=[<number>]22m, 1m-j[<number>]0m + Specify the number of jobs to run in parallel. The default is 1m122m. + + 1m--retry=[<number>]0m + Retry failed network or git requests for 4mnumber24m times. + + 1m--quiet0m + Only output warnings and errors. + + 1m--redownload0m + Force downloading every gem. + + 1m--patch0m + Prefer updating only to next patch version. + + 1m--minor0m + Prefer updating only to next minor version. + + 1m--major0m + Prefer updating to next major version (default). + + 1m--strict0m + Do not allow any gem to be updated past latest 1m--patch 22m| 1m--minor0m + | 1m--major22m. + + 1m--conservative0m + Use bundle install conservative update behavior and do not allow + 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 + versions of all gems available in the sources. + + Consider the following Gemfile(5): + + + + source "https://rubygems.org" + + gem "rails", "3.0.0.rc" + gem "nokogiri" + + + + 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: + + + + Fetching gem metadata from https://rubygems.org/......... + Resolving dependencies... + Installing builder 2.1.2 + Installing abstract 1.0.0 + Installing rack 1.2.8 + Using bundler 1.7.6 + Installing rake 10.4.0 + Installing polyglot 0.3.5 + Installing mime-types 1.25.1 + Installing i18n 0.4.2 + Installing mini_portile 0.6.1 + Installing tzinfo 0.3.42 + Installing rack-mount 0.6.14 + Installing rack-test 0.5.7 + Installing treetop 1.4.15 + Installing thor 0.14.6 + Installing activesupport 3.0.0.rc + Installing erubis 2.6.6 + Installing activemodel 3.0.0.rc + Installing arel 0.4.0 + Installing mail 2.2.20 + Installing activeresource 3.0.0.rc + Installing actionpack 3.0.0.rc + Installing activerecord 3.0.0.rc + Installing actionmailer 3.0.0.rc + Installing railties 3.0.0.rc + Installing rails 3.0.0.rc + Installing nokogiri 1.6.5 + + Bundle complete! 2 Gemfile dependencies, 26 gems total. + Use `bundle show [gemname]` to see where a bundled gem is installed. + + + + 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 + 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- + 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 + 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 + 1mGemfile.lock22m. + + 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 + 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 + 1mthin 22mand 1mrack-perftools-profiler22m. + + + + source "https://rubygems.org" + + gem "thin" + gem "rack-perftools-profiler" + + + + The 1mthin 22mgem depends on 1mrack >= 1.022m, while 1mrack-perftools-profiler0m + depends on 1mrack ~> 1.022m. If you run bundle install, you get: + + + + Fetching source index for https://rubygems.org/ + Installing daemons (1.1.0) + Installing eventmachine (0.12.10) with native extensions + Installing open4 (1.0.1) + Installing perftools.rb (0.4.7) with native extensions + Installing rack (1.2.1) + Installing rack-perftools_profiler (0.0.2) + Installing thin (1.2.7) with native extensions + Using bundler (1.0.0.rc.3) + + + + 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 + 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 + are also dependencies of another gem. + + To prevent updating shared dependencies, prior to version 1.14 the only + option was the 1mCONSERVATIVE UPDATING 22mbehavior in bundle install(1) 4mbun-0m + 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, + see the 1mCONSERVATIVE UPDATING 22msection of bundle install(1) 4mbun-0m + 4mdle-install.1.html24m. + + Starting with 1.14, specifying the 1m--conservative 22moption will also pre- + 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: + 1m--patch22m, 1m--minor 22mor 1m--major22m. 1m--strict 22mcan be added to further influence + resolution. + + 1m--patch0m + Prefer updating only to next patch version. + + 1m--minor0m + Prefer updating only to next minor version. + + 1m--major0m + Prefer updating to next major version (default). + + 1m--strict0m + 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- + 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 + 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 + 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 + "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 + "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 + ensure that no gem is updated that far. + + 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.4, 1.0.3, 1.0.2". + + 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 + thing as providing the 1m--minor 22mand 1m--strict 22moptions. + +1mPATCH LEVEL EXAMPLES0m + Given the following gem specifications: + + + + foo 1.4.3, requires: ~> bar 2.0 + foo 1.4.4, requires: ~> bar 2.0 + foo 1.4.5, requires: ~> bar 2.1 + foo 1.5.0, requires: ~> bar 2.1 + foo 1.5.1, requires: ~> bar 3.0 + bar with versions 2.0.3, 2.0.4, 2.1.0, 2.1.1, 3.0.0 + + + + Gemfile: + + + + gem 'foo' + + + + Gemfile.lock: + + + + foo (1.4.3) + bar (~> 2.0) + bar (2.0.3) + + + + Cases: + + + + # Command Line Result + ------------------------------------------------------------ + 1 bundle update --patch 'foo 1.4.5', 'bar 2.1.1' + 2 bundle update --patch foo 'foo 1.4.5', 'bar 2.1.1' + 3 bundle update --minor 'foo 1.5.1', 'bar 3.0.0' + 4 bundle update --minor --strict 'foo 1.5.0', 'bar 2.1.1' + 5 bundle update --patch --strict 'foo 1.4.4', 'bar 2.0.4' + + + + 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 + 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 + 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 + 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 + move is up to 1.4.4 and 2.0.4. + +1mRECOMMENDED WORKFLOW0m + 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 + + $ bundle install + + o Check the resulting 1mGemfile.lock 22minto version control + + $ git add Gemfile.lock + + o When checking out this repository on another development machine, + run + + $ bundle install + + o When checking out this repository on a deployment machine, run + + $ bundle install --deployment + + o After changing the Gemfile(5) to reflect a new or update depen- + dency, run + + $ bundle install + + o Make sure to check the updated 1mGemfile.lock 22minto version control + + $ git add Gemfile.lock + + o If bundle install(1) 4mbundle-install.1.html24m reports a conflict, man- + ually update the specific gems that you changed in the Gemfile(5) + + $ bundle update rails thin + + 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 + + + + + + + October 2018 BUNDLE-UPDATE(1) diff --git a/man/bundle-update.ronn b/man/bundle-update.ronn new file mode 100644 index 0000000000..481bb5b14e --- /dev/null +++ b/man/bundle-update.ronn @@ -0,0 +1,350 @@ +bundle-update(1) -- Update your gems to the latest available versions +===================================================================== + +## SYNOPSIS + +`bundle update` <*gems> [--all] + [--group=NAME] + [--source=NAME] + [--local] + [--ruby] + [--bundler[=VERSION]] + [--full-index] + [--jobs=JOBS] + [--quiet] + [--force] + [--patch|--minor|--major] + [--strict] + [--conservative] + +## DESCRIPTION + +Update the gems specified (all gems, if `--all` flag is used), ignoring +the previously installed gems specified in the `Gemfile.lock`. In +general, you should use [bundle install(1)](bundle-install.1.html) to install the same exact +gems and versions across machines. + +You would use `bundle update` to explicitly update the version of a +gem. + +## OPTIONS + +* `--all`: + Update all gems specified in Gemfile. + +* `--group=<name>`, `-g=[<name>]`: + Only update the gems in the specified group. For instance, you can update all gems + in the development group with `bundle update --group development`. You can also + call `bundle update rails --group test` to update the rails gem and all gems in + the test group, for example. + +* `--source=<name>`: + The name of a `:git` or `:path` source used in the Gemfile(5). For + instance, with a `:git` source of `http://github.com/rails/rails.git`, + you would call `bundle update --source rails` + +* `--local`: + Do not attempt to fetch gems remotely and use the gem cache instead. + +* `--ruby`: + Update the locked version of Ruby to the current version of Ruby. + +* `--bundler`: + Update the locked version of bundler to the invoked bundler version. + +* `--full-index`: + Fall back to using the single-file index of all gems. + +* `--jobs=[<number>]`, `-j[<number>]`: + Specify the number of jobs to run in parallel. The default is `1`. + +* `--retry=[<number>]`: + Retry failed network or git requests for <number> times. + +* `--quiet`: + Only output warnings and errors. + +* `--force`: + Force downloading every gem. `--redownload` is an alias of this option. + +* `--patch`: + Prefer updating only to next patch version. + +* `--minor`: + Prefer updating only to next minor version. + +* `--major`: + Prefer updating to next major version (default). + +* `--strict`: + Do not allow any gem to be updated past latest `--patch` | `--minor` | `--major`. + +* `--conservative`: + Use bundle install conservative update behavior and do not allow shared dependencies to be updated. + +## UPDATING ALL GEMS + +If you run `bundle update --all`, 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): + + source "https://rubygems.org" + + gem "rails", "3.0.0.rc" + gem "nokogiri" + +When you run [bundle install(1)](bundle-install.1.html) the first time, bundler will resolve +all of the dependencies, all the way down, and install what you need: + + Fetching gem metadata from https://rubygems.org/......... + Resolving dependencies... + Installing builder 2.1.2 + Installing abstract 1.0.0 + Installing rack 1.2.8 + Using bundler 1.7.6 + Installing rake 10.4.0 + Installing polyglot 0.3.5 + Installing mime-types 1.25.1 + Installing i18n 0.4.2 + Installing mini_portile 0.6.1 + Installing tzinfo 0.3.42 + Installing rack-mount 0.6.14 + Installing rack-test 0.5.7 + Installing treetop 1.4.15 + Installing thor 0.14.6 + Installing activesupport 3.0.0.rc + Installing erubis 2.6.6 + Installing activemodel 3.0.0.rc + Installing arel 0.4.0 + Installing mail 2.2.20 + Installing activeresource 3.0.0.rc + Installing actionpack 3.0.0.rc + Installing activerecord 3.0.0.rc + Installing actionmailer 3.0.0.rc + Installing railties 3.0.0.rc + Installing rails 3.0.0.rc + Installing nokogiri 1.6.5 + + Bundle complete! 2 Gemfile dependencies, 26 gems total. + Use `bundle show [gemname]` to see where a bundled gem is installed. + +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 `Gemfile.lock`. The next time you run [bundle install(1)](bundle-install.1.html), bundler skips +the dependency resolution and installs the same gems as it installed last time. + +After checking in the `Gemfile.lock` into version control and cloning it on another +machine, running [bundle install(1)](bundle-install.1.html) will _still_ install the gems that you installed +last time. You don't need to worry that a new release of `erubis` or `mail` changes +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 Gemfile(5). + +To do this, run `bundle update --all`, which will ignore the `Gemfile.lock`, 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 `bundle update --all`. + +## 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, in the scenario above, imagine that `nokogiri` releases version `1.4.4`, and +you want to update it _without_ updating Rails and all of its dependencies. To do this, +run `bundle update nokogiri`. + +Bundler will update `nokogiri` and any of its dependencies, but leave alone Rails and +its dependencies. + +## OVERLAPPING DEPENDENCIES + +Sometimes, multiple gems declared in your Gemfile(5) are satisfied by the same +second-level dependency. For instance, consider the case of `thin` and +`rack-perftools-profiler`. + + source "https://rubygems.org" + + gem "thin" + gem "rack-perftools-profiler" + +The `thin` gem depends on `rack >= 1.0`, while `rack-perftools-profiler` depends +on `rack ~> 1.0`. If you run bundle install, you get: + + Fetching source index for https://rubygems.org/ + Installing daemons (1.1.0) + Installing eventmachine (0.12.10) with native extensions + Installing open4 (1.0.1) + Installing perftools.rb (0.4.7) with native extensions + Installing rack (1.2.1) + Installing rack-perftools_profiler (0.0.2) + Installing thin (1.2.7) with native extensions + Using bundler (1.0.0.rc.3) + +In this case, the two gems have their own set of dependencies, but they share +`rack` in common. If you run `bundle update thin`, bundler will update `daemons`, +`eventmachine` and `rack`, which are dependencies of `thin`, but not `open4` or +`perftools.rb`, which are dependencies of `rack-perftools_profiler`. Note that +`bundle update thin` will update `rack` even though it's _also_ a dependency of +`rack-perftools_profiler`. + +In short, by default, when you update a gem using `bundle update`, 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 option +was the `CONSERVATIVE UPDATING` behavior in [bundle install(1)](bundle-install.1.html): + +In this scenario, updating the `thin` version manually in the Gemfile(5), +and then running [bundle install(1)](bundle-install.1.html) will only update `daemons` and `eventmachine`, +but not `rack`. For more information, see the `CONSERVATIVE UPDATING` section +of [bundle install(1)](bundle-install.1.html). + +Starting with 1.14, specifying the `--conservative` option will also prevent shared +dependencies from being updated. + +## PATCH LEVEL OPTIONS + +Version 1.14 introduced 4 patch-level options that will influence how gem +versions are resolved. One of the following options can be used: `--patch`, +`--minor` or `--major`. `--strict` can be added to further influence resolution. + +* `--patch`: + Prefer updating only to next patch version. + +* `--minor`: + Prefer updating only to next minor version. + +* `--major`: + Prefer updating to next major version (default). + +* `--strict`: + Do not allow any gem to be updated past latest `--patch` | `--minor` | `--major`. + +When Bundler is resolving what versions to use to satisfy declared +requirements in the Gemfile or in parent gems, it looks up all +available versions, filters out any versions that don't satisfy +the requirement, and then, by default, sorts them from newest to +oldest, considering them in that order. + +Providing one of the patch level options (e.g. `--patch`) changes the +sort order of the satisfying versions, causing Bundler to consider the +latest `--patch` or `--minor` version 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 +all exist, the default order of preference by default (`--major`) will +be "2.0.0, 1.1.1, 1.1.0, 1.0.4, 1.0.3, 1.0.2". + +If the `--patch` option 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 `--minor` option 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 `--strict` option 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 `--patch` and `--strict` +options are used, the available versions for resolution would be +"1.0.4, 1.0.3, 1.0.2". If `--minor` and `--strict` are 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 +determining factor for what versions are available. If the gem +requirement for `foo` in the Gemfile is '~> 1.0', that will accomplish +the same thing as providing the `--minor` and `--strict` options. + +## PATCH LEVEL EXAMPLES + +Given the following gem specifications: + + foo 1.4.3, requires: ~> bar 2.0 + foo 1.4.4, requires: ~> bar 2.0 + foo 1.4.5, requires: ~> bar 2.1 + foo 1.5.0, requires: ~> bar 2.1 + foo 1.5.1, requires: ~> bar 3.0 + bar with versions 2.0.3, 2.0.4, 2.1.0, 2.1.1, 3.0.0 + +Gemfile: + + gem 'foo' + +Gemfile.lock: + + foo (1.4.3) + bar (~> 2.0) + bar (2.0.3) + +Cases: + + # Command Line Result + ------------------------------------------------------------ + 1 bundle update --patch 'foo 1.4.5', 'bar 2.1.1' + 2 bundle update --patch foo 'foo 1.4.5', 'bar 2.1.1' + 3 bundle update --minor 'foo 1.5.1', 'bar 3.0.0' + 4 bundle update --minor --strict 'foo 1.5.0', 'bar 2.1.1' + 5 bundle update --patch --strict 'foo 1.4.4', 'bar 2.0.4' + +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 +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 +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 +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 +move is up to 1.4.4 and 2.0.4. + +## RECOMMENDED WORKFLOW + +In general, when working with an application managed with bundler, you should +use the following workflow: + +* After you create your Gemfile(5) for the first time, run + + $ bundle install + +* Check the resulting `Gemfile.lock` into version control + + $ git add Gemfile.lock + +* When checking out this repository on another development machine, run + + $ bundle install + +* When checking out this repository on a deployment machine, run + + $ bundle install --deployment + +* After changing the Gemfile(5) to reflect a new or update dependency, run + + $ bundle install + +* Make sure to check the updated `Gemfile.lock` into version control + + $ git add Gemfile.lock + +* If [bundle install(1)](bundle-install.1.html) reports a conflict, manually update the specific + gems that you changed in the Gemfile(5) + + $ bundle update rails thin + +* 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 diff --git a/man/bundle-viz.1 b/man/bundle-viz.1 new file mode 100644 index 0000000000..662c91991e --- /dev/null +++ b/man/bundle-viz.1 @@ -0,0 +1,39 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BUNDLE\-VIZ" "1" "October 2018" "" "" +. +.SH "NAME" +\fBbundle\-viz\fR \- Generates a visual dependency graph for your Gemfile +. +.SH "SYNOPSIS" +\fBbundle viz\fR [\-\-file=FILE] [\-\-format=FORMAT] [\-\-requirements] [\-\-version] [\-\-without=GROUP GROUP] +. +.SH "DESCRIPTION" +\fBviz\fR generates a PNG file of the current \fBGemfile(5)\fR as a dependency graph\. \fBviz\fR requires the ruby\-graphviz gem (and its dependencies)\. +. +.P +The associated gems must also be installed via \fBbundle install(1)\fR \fIbundle\-install\.1\.html\fR\. +. +.SH "OPTIONS" +. +.TP +\fB\-\-file\fR, \fB\-f\fR +The name to use for the generated file\. See \fB\-\-format\fR option +. +.TP +\fB\-\-format\fR, \fB\-F\fR +This is output format option\. Supported format is png, jpg, svg, dot \.\.\. +. +.TP +\fB\-\-requirements\fR, \fB\-R\fR +Set to show the version of each required dependency\. +. +.TP +\fB\-\-version\fR, \fB\-v\fR +Set to show each gem version\. +. +.TP +\fB\-\-without\fR, \fB\-W\fR +Exclude gems that are part of the specified named group\. + diff --git a/man/bundle-viz.1.txt b/man/bundle-viz.1.txt new file mode 100644 index 0000000000..30a7d68d09 --- /dev/null +++ b/man/bundle-viz.1.txt @@ -0,0 +1,39 @@ +BUNDLE-VIZ(1) BUNDLE-VIZ(1) + + + +1mNAME0m + 1mbundle-viz 22m- Generates a visual dependency graph for your Gemfile + +1mSYNOPSIS0m + 1mbundle viz 22m[--file=FILE] [--format=FORMAT] [--requirements] [--version] + [--without=GROUP GROUP] + +1mDESCRIPTION0m + 1mviz 22mgenerates a PNG file of the current 1mGemfile(5) 22mas a dependency + graph. 1mviz 22mrequires the ruby-graphviz gem (and its dependencies). + + The associated gems must also be installed via 1mbundle install(1) 4m22mbun-0m + 4mdle-install.1.html24m. + +1mOPTIONS0m + 1m--file22m, 1m-f0m + The name to use for the generated file. See 1m--format 22moption + + 1m--format22m, 1m-F0m + This is output format option. Supported format is png, jpg, svg, + dot ... + + 1m--requirements22m, 1m-R0m + Set to show the version of each required dependency. + + 1m--version22m, 1m-v0m + Set to show each gem version. + + 1m--without22m, 1m-W0m + Exclude gems that are part of the specified named group. + + + + + October 2018 BUNDLE-VIZ(1) diff --git a/man/bundle-viz.ronn b/man/bundle-viz.ronn new file mode 100644 index 0000000000..701df5415e --- /dev/null +++ b/man/bundle-viz.ronn @@ -0,0 +1,30 @@ +bundle-viz(1) -- Generates a visual dependency graph for your Gemfile +===================================================================== + +## SYNOPSIS + +`bundle viz` [--file=FILE] + [--format=FORMAT] + [--requirements] + [--version] + [--without=GROUP GROUP] + +## DESCRIPTION + +`viz` generates a PNG file of the current `Gemfile(5)` as a dependency graph. +`viz` requires the ruby-graphviz gem (and its dependencies). + +The associated gems must also be installed via [`bundle install(1)`](bundle-install.1.html). + +## OPTIONS + +* `--file`, `-f`: + The name to use for the generated file. See `--format` option +* `--format`, `-F`: + This is output format option. Supported format is png, jpg, svg, dot ... +* `--requirements`, `-R`: + Set to show the version of each required dependency. +* `--version`, `-v`: + Set to show each gem version. +* `--without`, `-W`: + Exclude gems that are part of the specified named group. diff --git a/man/bundle.1 b/man/bundle.1 new file mode 100644 index 0000000000..341c6ac71b --- /dev/null +++ b/man/bundle.1 @@ -0,0 +1,132 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BUNDLE" "1" "October 2018" "" "" +. +.SH "NAME" +\fBbundle\fR \- Ruby Dependency Management +. +.SH "SYNOPSIS" +\fBbundle\fR COMMAND [\-\-no\-color] [\-\-verbose] [ARGS] +. +.SH "DESCRIPTION" +Bundler manages an \fBapplication\'s dependencies\fR through its entire life across many machines systematically and repeatably\. +. +.P +See the bundler website \fIhttp://bundler\.io\fR for information on getting started, and Gemfile(5) for more information on the \fBGemfile\fR format\. +. +.SH "OPTIONS" +. +.TP +\fB\-\-no\-color\fR +Print all output without color +. +.TP +\fB\-\-retry\fR, \fB\-r\fR +Specify the number of times you wish to attempt network commands +. +.TP +\fB\-\-verbose\fR, \fB\-V\fR +Print out additional logging information +. +.SH "BUNDLE COMMANDS" +We divide \fBbundle\fR subcommands into primary commands and utilities: +. +.SH "PRIMARY COMMANDS" +. +.TP +\fBbundle install(1)\fR \fIbundle\-install\.1\.html\fR +Install the gems specified by the \fBGemfile\fR or \fBGemfile\.lock\fR +. +.TP +\fBbundle update(1)\fR \fIbundle\-update\.1\.html\fR +Update dependencies to their latest versions +. +.TP +\fBbundle package(1)\fR \fIbundle\-package\.1\.html\fR +Package the \.gem files required by your application into the \fBvendor/cache\fR directory +. +.TP +\fBbundle exec(1)\fR \fIbundle\-exec\.1\.html\fR +Execute a script in the current bundle +. +.TP +\fBbundle config(1)\fR \fIbundle\-config\.1\.html\fR +Specify and read configuration options for Bundler +. +.TP +\fBbundle help(1)\fR +Display detailed help for each subcommand +. +.SH "UTILITIES" +. +.TP +\fBbundle add(1)\fR \fIbundle\-add\.1\.html\fR +Add the named gem to the Gemfile and run \fBbundle install\fR +. +.TP +\fBbundle binstubs(1)\fR \fIbundle\-binstubs\.1\.html\fR +Generate binstubs for executables in a gem +. +.TP +\fBbundle check(1)\fR \fIbundle\-check\.1\.html\fR +Determine whether the requirements for your application are installed and available to Bundler +. +.TP +\fBbundle show(1)\fR \fIbundle\-show\.1\.html\fR +Show the source location of a particular gem in the bundle +. +.TP +\fBbundle outdated(1)\fR \fIbundle\-outdated\.1\.html\fR +Show all of the outdated gems in the current bundle +. +.TP +\fBbundle console(1)\fR +Start an IRB session in the current bundle +. +.TP +\fBbundle open(1)\fR \fIbundle\-open\.1\.html\fR +Open an installed gem in the editor +. +.TP +\fBbundle lock(1)\fR \fIbundle\-lock\.1\.hmtl\fR +Generate a lockfile for your dependencies +. +.TP +\fBbundle viz(1)\fR \fIbundle\-viz\.1\.html\fR +Generate a visual representation of your dependencies +. +.TP +\fBbundle init(1)\fR \fIbundle\-init\.1\.html\fR +Generate a simple \fBGemfile\fR, placed in the current directory +. +.TP +\fBbundle gem(1)\fR \fIbundle\-gem\.1\.html\fR +Create a simple gem, suitable for development with Bundler +. +.TP +\fBbundle platform(1)\fR \fIbundle\-platform\.1\.html\fR +Display platform compatibility information +. +.TP +\fBbundle clean(1)\fR \fIbundle\-clean\.1\.html\fR +Clean up unused gems in your Bundler directory +. +.TP +\fBbundle doctor(1)\fR \fIbundle\-doctor\.1\.html\fR +Display warnings about common problems +. +.SH "PLUGINS" +When running a command that isn\'t listed in PRIMARY COMMANDS or UTILITIES, Bundler will try to find an executable on your path named \fBbundler\-<command>\fR and execute it, passing down any extra arguments to it\. +. +.SH "OBSOLETE" +These commands are obsolete and should no longer be used: +. +.IP "\(bu" 4 +\fBbundle cache(1)\fR +. +.IP "\(bu" 4 +\fBbundle show(1)\fR +. +.IP "" 0 + diff --git a/man/bundle.1.txt b/man/bundle.1.txt new file mode 100644 index 0000000000..cf03adcf82 --- /dev/null +++ b/man/bundle.1.txt @@ -0,0 +1,113 @@ +BUNDLE(1) BUNDLE(1) + + + +1mNAME0m + 1mbundle 22m- Ruby Dependency Management + +1mSYNOPSIS0m + 1mbundle 22mCOMMAND [--no-color] [--verbose] [ARGS] + +1mDESCRIPTION0m + Bundler manages an 1mapplication's dependencies 22mthrough its entire life + across many machines systematically and repeatably. + + See the bundler website 4mhttp://bundler.io24m for information on getting + started, and Gemfile(5) for more information on the 1mGemfile 22mformat. + +1mOPTIONS0m + 1m--no-color0m + Print all output without color + + 1m--retry22m, 1m-r0m + Specify the number of times you wish to attempt network commands + + 1m--verbose22m, 1m-V0m + Print out additional logging information + +1mBUNDLE COMMANDS0m + We divide 1mbundle 22msubcommands into primary commands and utilities: + +1mPRIMARY COMMANDS0m + 1mbundle install(1) 4m22mbundle-install.1.html0m + Install the gems specified by the 1mGemfile 22mor 1mGemfile.lock0m + + 1mbundle update(1) 4m22mbundle-update.1.html0m + Update dependencies to their latest versions + + 1mbundle package(1) 4m22mbundle-package.1.html0m + Package the .gem files required by your application into the + 1mvendor/cache 22mdirectory + + 1mbundle exec(1) 4m22mbundle-exec.1.html0m + Execute a script in the current bundle + + 1mbundle config(1) 4m22mbundle-config.1.html0m + Specify and read configuration options for Bundler + + 1mbundle help(1)0m + Display detailed help for each subcommand + +1mUTILITIES0m + 1mbundle add(1) 4m22mbundle-add.1.html0m + Add the named gem to the Gemfile and run 1mbundle install0m + + 1mbundle binstubs(1) 4m22mbundle-binstubs.1.html0m + Generate binstubs for executables in a gem + + 1mbundle check(1) 4m22mbundle-check.1.html0m + Determine whether the requirements for your application are + installed and available to Bundler + + 1mbundle show(1) 4m22mbundle-show.1.html0m + Show the source location of a particular gem in the bundle + + 1mbundle outdated(1) 4m22mbundle-outdated.1.html0m + Show all of the outdated gems in the current bundle + + 1mbundle console(1)0m + Start an IRB session in the current bundle + + 1mbundle open(1) 4m22mbundle-open.1.html0m + Open an installed gem in the editor + + 1mbundle lock(1) 4m22mbundle-lock.1.hmtl0m + Generate a lockfile for your dependencies + + 1mbundle viz(1) 4m22mbundle-viz.1.html0m + Generate a visual representation of your dependencies + + 1mbundle init(1) 4m22mbundle-init.1.html0m + Generate a simple 1mGemfile22m, placed in the current directory + + 1mbundle gem(1) 4m22mbundle-gem.1.html0m + Create a simple gem, suitable for development with Bundler + + 1mbundle platform(1) 4m22mbundle-platform.1.html0m + Display platform compatibility information + + 1mbundle clean(1) 4m22mbundle-clean.1.html0m + Clean up unused gems in your Bundler directory + + 1mbundle doctor(1) 4m22mbundle-doctor.1.html0m + Display warnings about common problems + +1mPLUGINS0m + When running a command that isn't listed in PRIMARY COMMANDS or UTILI- + TIES, Bundler will try to find an executable on your path named + 1mbundler-<command> 22mand execute it, passing down any extra arguments to + it. + +1mOBSOLETE0m + These commands are obsolete and should no longer be used: + + o 1mbundle cache(1)0m + + o 1mbundle show(1)0m + + + + + + + October 2018 BUNDLE(1) diff --git a/man/bundle.ronn b/man/bundle.ronn new file mode 100644 index 0000000000..c03201a30c --- /dev/null +++ b/man/bundle.ronn @@ -0,0 +1,108 @@ +bundle(1) -- Ruby Dependency Management +======================================= + +## SYNOPSIS + +`bundle` COMMAND [--no-color] [--verbose] [ARGS] + +## DESCRIPTION + +Bundler manages an `application's dependencies` through its entire life +across many machines systematically and repeatably. + +See [the bundler website](http://bundler.io) for information on getting +started, and Gemfile(5) for more information on the `Gemfile` format. + +## OPTIONS + +* `--no-color`: + Print all output without color + +* `--retry`, `-r`: + Specify the number of times you wish to attempt network commands + +* `--verbose`, `-V`: + Print out additional logging information + +## BUNDLE COMMANDS + +We divide `bundle` subcommands into primary commands and utilities: + +## PRIMARY COMMANDS + +* [`bundle install(1)`](bundle-install.1.html): + Install the gems specified by the `Gemfile` or `Gemfile.lock` + +* [`bundle update(1)`](bundle-update.1.html): + Update dependencies to their latest versions + +* [`bundle package(1)`](bundle-package.1.html): + Package the .gem files required by your application into the + `vendor/cache` directory + +* [`bundle exec(1)`](bundle-exec.1.html): + Execute a script in the current bundle + +* [`bundle config(1)`](bundle-config.1.html): + Specify and read configuration options for Bundler + +* `bundle help(1)`: + Display detailed help for each subcommand + +## UTILITIES + +* [`bundle add(1)`](bundle-add.1.html): + Add the named gem to the Gemfile and run `bundle install` + +* [`bundle binstubs(1)`](bundle-binstubs.1.html): + Generate binstubs for executables in a gem + +* [`bundle check(1)`](bundle-check.1.html): + Determine whether the requirements for your application are installed + and available to Bundler + +* [`bundle show(1)`](bundle-show.1.html): + Show the source location of a particular gem in the bundle + +* [`bundle outdated(1)`](bundle-outdated.1.html): + Show all of the outdated gems in the current bundle + +* `bundle console(1)`: + Start an IRB session in the current bundle + +* [`bundle open(1)`](bundle-open.1.html): + Open an installed gem in the editor + +* [`bundle lock(1)`](bundle-lock.1.hmtl): + Generate a lockfile for your dependencies + +* [`bundle viz(1)`](bundle-viz.1.html): + Generate a visual representation of your dependencies + +* [`bundle init(1)`](bundle-init.1.html): + Generate a simple `Gemfile`, placed in the current directory + +* [`bundle gem(1)`](bundle-gem.1.html): + Create a simple gem, suitable for development with Bundler + +* [`bundle platform(1)`](bundle-platform.1.html): + Display platform compatibility information + +* [`bundle clean(1)`](bundle-clean.1.html): + Clean up unused gems in your Bundler directory + +* [`bundle doctor(1)`](bundle-doctor.1.html): + Display warnings about common problems + +## PLUGINS + +When running a command that isn't listed in PRIMARY COMMANDS or UTILITIES, +Bundler will try to find an executable on your path named `bundler-<command>` +and execute it, passing down any extra arguments to it. + +## OBSOLETE + +These commands are obsolete and should no longer be used: + +* `bundle cache(1)` +* `bundle show(1)` diff --git a/man/gemfile.5 b/man/gemfile.5 new file mode 100644 index 0000000000..db89219d6c --- /dev/null +++ b/man/gemfile.5 @@ -0,0 +1,689 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "GEMFILE" "5" "October 2018" "" "" +. +.SH "NAME" +\fBGemfile\fR \- A format for describing gem dependencies for Ruby programs +. +.SH "SYNOPSIS" +A \fBGemfile\fR describes the gem dependencies required to execute associated Ruby code\. +. +.P +Place the \fBGemfile\fR in the root of the directory containing the associated code\. For instance, in a Rails application, place the \fBGemfile\fR in the same directory as the \fBRakefile\fR\. +. +.SH "SYNTAX" +A \fBGemfile\fR is evaluated as Ruby code, in a context which makes available a number of methods used to describe the gem requirements\. +. +.SH "GLOBAL SOURCES" +At the top of the \fBGemfile\fR, add a line for the \fBRubygems\fR source that contains the gems listed in the \fBGemfile\fR\. +. +.IP "" 4 +. +.nf + +source "https://rubygems\.org" +. +.fi +. +.IP "" 0 +. +.P +It is possible, but not recommended as of Bundler 1\.7, to add multiple global \fBsource\fR lines\. Each of these \fBsource\fRs \fBMUST\fR be a valid Rubygems repository\. +. +.P +Sources are checked for gems following the heuristics described in \fISOURCE PRIORITY\fR\. If a gem is found in more than one global source, Bundler will print a warning after installing the gem indicating which source was used, and listing the other sources where the gem is available\. A specific source can be selected for gems that need to use a non\-standard repository, suppressing this warning, by using the \fI\fB:source\fR option\fR or a \fI\fBsource\fR block\fR\. +. +.SS "CREDENTIALS" +Some gem sources require a username and password\. Use bundle config(1) \fIbundle\-config\.1\.html\fR to set the username and password for any of the sources that need it\. The command must be run once on each computer that will install the Gemfile, but this keeps the credentials from being stored in plain text in version control\. +. +.IP "" 4 +. +.nf + +bundle config gems\.example\.com user:password +. +.fi +. +.IP "" 0 +. +.P +For some sources, like a company Gemfury account, it may be easier to include the credentials in the Gemfile as part of the source URL\. +. +.IP "" 4 +. +.nf + +source "https://user:password@gems\.example\.com" +. +.fi +. +.IP "" 0 +. +.P +Credentials in the source URL will take precedence over credentials set using \fBconfig\fR\. +. +.SH "RUBY" +If your application requires a specific Ruby version or engine, specify your requirements using the \fBruby\fR method, with the following arguments\. All parameters are \fBOPTIONAL\fR unless otherwise specified\. +. +.SS "VERSION (required)" +The version of Ruby that your application requires\. If your application requires an alternate Ruby engine, such as JRuby, Rubinius or TruffleRuby, this should be the Ruby version that the engine is compatible with\. +. +.IP "" 4 +. +.nf + +ruby "1\.9\.3" +. +.fi +. +.IP "" 0 +. +.SS "ENGINE" +Each application \fImay\fR specify a Ruby engine\. If an engine is specified, an engine version \fImust\fR also be specified\. +. +.P +What exactly is an Engine? \- A Ruby engine is an implementation of the Ruby language\. +. +.IP "\(bu" 4 +For background: the reference or original implementation of the Ruby programming language is called Matz\'s Ruby Interpreter \fIhttps://en\.wikipedia\.org/wiki/Ruby_MRI\fR, or MRI for short\. This is named after Ruby creator Yukihiro Matsumoto, also known as Matz\. MRI is also known as CRuby, because it is written in C\. MRI is the most widely used Ruby engine\. +. +.IP "\(bu" 4 +Other implementations \fIhttps://www\.ruby\-lang\.org/en/about/\fR of Ruby exist\. Some of the more well\-known implementations include Rubinius \fIhttps://rubinius\.com/\fR, and JRuby \fIhttp://jruby\.org/\fR\. Rubinius is an alternative implementation of Ruby written in Ruby\. JRuby is an implementation of Ruby on the JVM, short for Java Virtual Machine\. +. +.IP "" 0 +. +.SS "ENGINE VERSION" +Each application \fImay\fR specify a Ruby engine version\. If an engine version is specified, an engine \fImust\fR also be specified\. If the engine is "ruby" the engine version specified \fImust\fR match the Ruby version\. +. +.IP "" 4 +. +.nf + +ruby "1\.8\.7", :engine => "jruby", :engine_version => "1\.6\.7" +. +.fi +. +.IP "" 0 +. +.SS "PATCHLEVEL" +Each application \fImay\fR specify a Ruby patchlevel\. +. +.IP "" 4 +. +.nf + +ruby "2\.0\.0", :patchlevel => "247" +. +.fi +. +.IP "" 0 +. +.SH "GEMS" +Specify gem requirements using the \fBgem\fR method, with the following arguments\. All parameters are \fBOPTIONAL\fR unless otherwise specified\. +. +.SS "NAME (required)" +For each gem requirement, list a single \fIgem\fR line\. +. +.IP "" 4 +. +.nf + +gem "nokogiri" +. +.fi +. +.IP "" 0 +. +.SS "VERSION" +Each \fIgem\fR \fBMAY\fR have one or more version specifiers\. +. +.IP "" 4 +. +.nf + +gem "nokogiri", ">= 1\.4\.2" +gem "RedCloth", ">= 4\.1\.0", "< 4\.2\.0" +. +.fi +. +.IP "" 0 +. +.SS "REQUIRE AS" +Each \fIgem\fR \fBMAY\fR specify files that should be used when autorequiring via \fBBundler\.require\fR\. You may pass an array with multiple files or \fBtrue\fR if file you want \fBrequired\fR has same name as \fIgem\fR or \fBfalse\fR to prevent any file from being autorequired\. +. +.IP "" 4 +. +.nf + +gem "redis", :require => ["redis/connection/hiredis", "redis"] +gem "webmock", :require => false +gem "debugger", :require => true +. +.fi +. +.IP "" 0 +. +.P +The argument defaults to the name of the gem\. For example, these are identical: +. +.IP "" 4 +. +.nf + +gem "nokogiri" +gem "nokogiri", :require => "nokogiri" +gem "nokogiri", :require => true +. +.fi +. +.IP "" 0 +. +.SS "GROUPS" +Each \fIgem\fR \fBMAY\fR specify membership in one or more groups\. Any \fIgem\fR that does not specify membership in any group is placed in the \fBdefault\fR group\. +. +.IP "" 4 +. +.nf + +gem "rspec", :group => :test +gem "wirble", :groups => [:development, :test] +. +.fi +. +.IP "" 0 +. +.P +The Bundler runtime allows its two main methods, \fBBundler\.setup\fR and \fBBundler\.require\fR, to limit their impact to particular groups\. +. +.IP "" 4 +. +.nf + +# setup adds gems to Ruby\'s load path +Bundler\.setup # defaults to all groups +require "bundler/setup" # same as Bundler\.setup +Bundler\.setup(:default) # only set up the _default_ group +Bundler\.setup(:test) # only set up the _test_ group (but `not` _default_) +Bundler\.setup(:default, :test) # set up the _default_ and _test_ groups, but no others + +# require requires all of the gems in the specified groups +Bundler\.require # defaults to the _default_ group +Bundler\.require(:default) # identical +Bundler\.require(:default, :test) # requires the _default_ and _test_ groups +Bundler\.require(:test) # requires the _test_ group +. +.fi +. +.IP "" 0 +. +.P +The Bundler CLI allows you to specify a list of groups whose gems \fBbundle install\fR should not install with the \fB\-\-without\fR option\. To specify multiple groups to ignore, specify a list of groups separated by spaces\. +. +.IP "" 4 +. +.nf + +bundle install \-\-without test +bundle install \-\-without development test +. +.fi +. +.IP "" 0 +. +.P +After running \fBbundle install \-\-without test\fR, bundler will remember that you excluded the test group in the last installation\. The next time you run \fBbundle install\fR, without any \fB\-\-without option\fR, bundler will recall it\. +. +.P +Also, calling \fBBundler\.setup\fR with no parameters, or calling \fBrequire "bundler/setup"\fR will setup all groups except for the ones you excluded via \fB\-\-without\fR (since they are not available)\. +. +.P +Note that on \fBbundle install\fR, bundler downloads and evaluates all gems, in order to create a single canonical list of all of the required gems and their dependencies\. This means that you cannot list different versions of the same gems in different groups\. For more details, see Understanding Bundler \fIhttp://bundler\.io/rationale\.html\fR\. +. +.SS "PLATFORMS" +If a gem should only be used in a particular platform or set of platforms, you can specify them\. Platforms are essentially identical to groups, except that you do not need to use the \fB\-\-without\fR install\-time flag to exclude groups of gems for other platforms\. +. +.P +There are a number of \fBGemfile\fR platforms: +. +.TP +\fBruby\fR +C Ruby (MRI), Rubinius or TruffleRuby, but \fBNOT\fR Windows +. +.TP +\fBmri\fR +Same as \fIruby\fR, but only C Ruby (MRI) +. +.TP +\fBmingw\fR +Windows 32 bit \'mingw32\' platform (aka RubyInstaller) +. +.TP +\fBx64_mingw\fR +Windows 64 bit \'mingw32\' platform (aka RubyInstaller x64) +. +.TP +\fBrbx\fR +Rubinius +. +.TP +\fBjruby\fR +JRuby +. +.TP +\fBtruffleruby\fR +TruffleRuby +. +.TP +\fBmswin\fR +Windows +. +.P +You can restrict further by platform and version for all platforms \fIexcept\fR for \fBrbx\fR, \fBjruby\fR, \fBtruffleruby\fR and \fBmswin\fR\. +. +.P +To specify a version in addition to a platform, append the version number without the delimiter to the platform\. For example, to specify that a gem should only be used on platforms with Ruby 2\.3, use: +. +.IP "" 4 +. +.nf + +ruby_23 +. +.fi +. +.IP "" 0 +. +.P +The full list of platforms and supported versions includes: +. +.TP +\fBruby\fR +1\.8, 1\.9, 2\.0, 2\.1, 2\.2, 2\.3, 2\.4, 2\.5 +. +.TP +\fBmri\fR +1\.8, 1\.9, 2\.0, 2\.1, 2\.2, 2\.3, 2\.4, 2\.5 +. +.TP +\fBmingw\fR +1\.8, 1\.9, 2\.0, 2\.1, 2\.2, 2\.3, 2\.4, 2\.5 +. +.TP +\fBx64_mingw\fR +2\.0, 2\.1, 2\.2, 2\.3, 2\.4, 2\.5 +. +.P +As with groups, you can specify one or more platforms: +. +.IP "" 4 +. +.nf + +gem "weakling", :platforms => :jruby +gem "ruby\-debug", :platforms => :mri_18 +gem "nokogiri", :platforms => [:mri_18, :jruby] +. +.fi +. +.IP "" 0 +. +.P +All operations involving groups (\fBbundle install\fR \fIbundle\-install\.1\.html\fR, \fBBundler\.setup\fR, \fBBundler\.require\fR) behave exactly the same as if any groups not matching the current platform were explicitly excluded\. +. +.SS "SOURCE" +You can select an alternate Rubygems repository for a gem using the \':source\' option\. +. +.IP "" 4 +. +.nf + +gem "some_internal_gem", :source => "https://gems\.example\.com" +. +.fi +. +.IP "" 0 +. +.P +This forces the gem to be loaded from this source and ignores any global sources declared at the top level of the file\. If the gem does not exist in this source, it will not be installed\. +. +.P +Bundler will search for child dependencies of this gem by first looking in the source selected for the parent, but if they are not found there, it will fall back on global sources using the ordering described in \fISOURCE PRIORITY\fR\. +. +.P +Selecting a specific source repository this way also suppresses the ambiguous gem warning described above in \fIGLOBAL SOURCES (#source)\fR\. +. +.P +Using the \fB:source\fR option for an individual gem will also make that source available as a possible global source for any other gems which do not specify explicit sources\. Thus, when adding gems with explicit sources, it is recommended that you also ensure all other gems in the Gemfile are using explicit sources\. +. +.SS "GIT" +If necessary, you can specify that a gem is located at a particular git repository using the \fB:git\fR parameter\. The repository can be accessed via several protocols: +. +.TP +\fBHTTP(S)\fR +gem "rails", :git => "https://github\.com/rails/rails\.git" +. +.TP +\fBSSH\fR +gem "rails", :git => "git@github\.com:rails/rails\.git" +. +.TP +\fBgit\fR +gem "rails", :git => "git://github\.com/rails/rails\.git" +. +.P +If using SSH, the user that you use to run \fBbundle install\fR \fBMUST\fR have the appropriate keys available in their \fB$HOME/\.ssh\fR\. +. +.P +\fBNOTE\fR: \fBhttp://\fR and \fBgit://\fR URLs should be avoided if at all possible\. These protocols are unauthenticated, so a man\-in\-the\-middle attacker can deliver malicious code and compromise your system\. HTTPS and SSH are strongly preferred\. +. +.P +The \fBgroup\fR, \fBplatforms\fR, and \fBrequire\fR options are available and behave exactly the same as they would for a normal gem\. +. +.P +A git repository \fBSHOULD\fR have at least one file, at the root of the directory containing the gem, with the extension \fB\.gemspec\fR\. This file \fBMUST\fR contain a valid gem specification, as expected by the \fBgem build\fR command\. +. +.P +If a git repository does not have a \fB\.gemspec\fR, bundler will attempt to create one, but it will not contain any dependencies, executables, or C extension compilation instructions\. As a result, it may fail to properly integrate into your application\. +. +.P +If a git repository does have a \fB\.gemspec\fR for the gem you attached it to, a version specifier, if provided, means that the git repository is only valid if the \fB\.gemspec\fR specifies a version matching the version specifier\. If not, bundler will print a warning\. +. +.IP "" 4 +. +.nf + +gem "rails", "2\.3\.8", :git => "https://github\.com/rails/rails\.git" +# bundle install will fail, because the \.gemspec in the rails +# repository\'s master branch specifies version 3\.0\.0 +. +.fi +. +.IP "" 0 +. +.P +If a git repository does \fBnot\fR have a \fB\.gemspec\fR for the gem you attached it to, a version specifier \fBMUST\fR be provided\. Bundler will use this version in the simple \fB\.gemspec\fR it creates\. +. +.P +Git repositories support a number of additional options\. +. +.TP +\fBbranch\fR, \fBtag\fR, and \fBref\fR +You \fBMUST\fR only specify at most one of these options\. The default is \fB:branch => "master"\fR +. +.TP +For example: +. +.IP +git "https://github\.com/rails/rails\.git", :branch => "5\-0\-stable" do +. +.IP +git "https://github\.com/rails/rails\.git", :tag => "v5\.0\.0" do +. +.IP +git "https://github\.com/rails/rails\.git", :ref => "4aded" do +. +.TP +\fBsubmodules\fR +For reference, a git submodule \fIhttps://git\-scm\.com/book/en/v2/Git\-Tools\-Submodules\fR lets you have another git repository within a subfolder of your repository\. Specify \fB:submodules => true\fR to cause bundler to expand any submodules included in the git repository +. +.P +If a git repository contains multiple \fB\.gemspecs\fR, each \fB\.gemspec\fR represents a gem located at the same place in the file system as the \fB\.gemspec\fR\. +. +.IP "" 4 +. +.nf + +|~rails [git root] +| |\-rails\.gemspec [rails gem located here] +|~actionpack +| |\-actionpack\.gemspec [actionpack gem located here] +|~activesupport +| |\-activesupport\.gemspec [activesupport gem located here] +|\.\.\. +. +.fi +. +.IP "" 0 +. +.P +To install a gem located in a git repository, bundler changes to the directory containing the gemspec, runs \fBgem build name\.gemspec\fR and then installs the resulting gem\. The \fBgem build\fR command, which comes standard with Rubygems, evaluates the \fB\.gemspec\fR in the context of the directory in which it is located\. +. +.SS "GIT SOURCE" +A custom git source can be defined via the \fBgit_source\fR method\. Provide the source\'s name as an argument, and a block which receives a single argument and interpolates it into a string to return the full repo address: +. +.IP "" 4 +. +.nf + +git_source(:stash){ |repo_name| "https://stash\.corp\.acme\.pl/#{repo_name}\.git" } +gem \'rails\', :stash => \'forks/rails\' +. +.fi +. +.IP "" 0 +. +.P +In addition, if you wish to choose a specific branch: +. +.IP "" 4 +. +.nf + +gem "rails", :stash => "forks/rails", :branch => "branch_name" +. +.fi +. +.IP "" 0 +. +.SS "GITHUB" +\fBNOTE\fR: This shorthand should be avoided until Bundler 2\.0, since it currently expands to an insecure \fBgit://\fR URL\. This allows a man\-in\-the\-middle attacker to compromise your system\. +. +.P +If the git repository you want to use is hosted on GitHub and is public, you can use the :github shorthand to specify the github username and repository name (without the trailing "\.git"), separated by a slash\. If both the username and repository name are the same, you can omit one\. +. +.IP "" 4 +. +.nf + +gem "rails", :github => "rails/rails" +gem "rails", :github => "rails" +. +.fi +. +.IP "" 0 +. +.P +Are both equivalent to +. +.IP "" 4 +. +.nf + +gem "rails", :git => "git://github\.com/rails/rails\.git" +. +.fi +. +.IP "" 0 +. +.P +Since the \fBgithub\fR method is a specialization of \fBgit_source\fR, it accepts a \fB:branch\fR named argument\. +. +.SS "GIST" +If the git repository you want to use is hosted as a Github Gist and is public, you can use the :gist shorthand to specify the gist identifier (without the trailing "\.git")\. +. +.IP "" 4 +. +.nf + +gem "the_hatch", :gist => "4815162342" +. +.fi +. +.IP "" 0 +. +.P +Is equivalent to: +. +.IP "" 4 +. +.nf + +gem "the_hatch", :git => "https://gist\.github\.com/4815162342\.git" +. +.fi +. +.IP "" 0 +. +.P +Since the \fBgist\fR method is a specialization of \fBgit_source\fR, it accepts a \fB:branch\fR named argument\. +. +.SS "BITBUCKET" +If the git repository you want to use is hosted on Bitbucket and is public, you can use the :bitbucket shorthand to specify the bitbucket username and repository name (without the trailing "\.git"), separated by a slash\. If both the username and repository name are the same, you can omit one\. +. +.IP "" 4 +. +.nf + +gem "rails", :bitbucket => "rails/rails" +gem "rails", :bitbucket => "rails" +. +.fi +. +.IP "" 0 +. +.P +Are both equivalent to +. +.IP "" 4 +. +.nf + +gem "rails", :git => "https://rails@bitbucket\.org/rails/rails\.git" +. +.fi +. +.IP "" 0 +. +.P +Since the \fBbitbucket\fR method is a specialization of \fBgit_source\fR, it accepts a \fB:branch\fR named argument\. +. +.SS "PATH" +You can specify that a gem is located in a particular location on the file system\. Relative paths are resolved relative to the directory containing the \fBGemfile\fR\. +. +.P +Similar to the semantics of the \fB:git\fR option, the \fB:path\fR option requires that the directory in question either contains a \fB\.gemspec\fR for the gem, or that you specify an explicit version that bundler should use\. +. +.P +Unlike \fB:git\fR, bundler does not compile C extensions for gems specified as paths\. +. +.IP "" 4 +. +.nf + +gem "rails", :path => "vendor/rails" +. +.fi +. +.IP "" 0 +. +.P +If you would like to use multiple local gems directly from the filesystem, you can set a global \fBpath\fR option to the path containing the gem\'s files\. This will automatically load gemspec files from subdirectories\. +. +.IP "" 4 +. +.nf + +path \'components\' do + gem \'admin_ui\' + gem \'public_ui\' +end +. +.fi +. +.IP "" 0 +. +.SH "BLOCK FORM OF SOURCE, GIT, PATH, GROUP and PLATFORMS" +The \fB:source\fR, \fB:git\fR, \fB:path\fR, \fB:group\fR, and \fB:platforms\fR options may be applied to a group of gems by using block form\. +. +.IP "" 4 +. +.nf + +source "https://gems\.example\.com" do + gem "some_internal_gem" + gem "another_internal_gem" +end + +git "https://github\.com/rails/rails\.git" do + gem "activesupport" + gem "actionpack" +end + +platforms :ruby do + gem "ruby\-debug" + gem "sqlite3" +end + +group :development, :optional => true do + gem "wirble" + gem "faker" +end +. +.fi +. +.IP "" 0 +. +.P +In the case of the group block form the :optional option can be given to prevent a group from being installed unless listed in the \fB\-\-with\fR option given to the \fBbundle install\fR command\. +. +.P +In the case of the \fBgit\fR block form, the \fB:ref\fR, \fB:branch\fR, \fB:tag\fR, and \fB:submodules\fR options may be passed to the \fBgit\fR method, and all gems in the block will inherit those options\. +. +.P +The presence of a \fBsource\fR block in a Gemfile also makes that source available as a possible global source for any other gems which do not specify explicit sources\. Thus, when defining source blocks, it is recommended that you also ensure all other gems in the Gemfile are using explicit sources, either via source blocks or \fB:source\fR directives on individual gems\. +. +.SH "INSTALL_IF" +The \fBinstall_if\fR method allows gems to be installed based on a proc or lambda\. This is especially useful for optional gems that can only be used if certain software is installed or some other conditions are met\. +. +.IP "" 4 +. +.nf + +install_if \-> { RUBY_PLATFORM =~ /darwin/ } do + gem "pasteboard" +end +. +.fi +. +.IP "" 0 +. +.SH "GEMSPEC" +The \fB\.gemspec\fR \fIhttp://guides\.rubygems\.org/specification\-reference/\fR file is where you provide metadata about your gem to Rubygems\. Some required Gemspec attributes include the name, description, and homepage of your gem\. This is also where you specify the dependencies your gem needs to run\. +. +.P +If you wish to use Bundler to help install dependencies for a gem while it is being developed, use the \fBgemspec\fR method to pull in the dependencies listed in the \fB\.gemspec\fR file\. +. +.P +The \fBgemspec\fR method adds any runtime dependencies as gem requirements in the default group\. It also adds development dependencies as gem requirements in the \fBdevelopment\fR group\. Finally, it adds a gem requirement on your project (\fB:path => \'\.\'\fR)\. In conjunction with \fBBundler\.setup\fR, this allows you to require project files in your test code as you would if the project were installed as a gem; you need not manipulate the load path manually or require project files via relative paths\. +. +.P +The \fBgemspec\fR method supports optional \fB:path\fR, \fB:glob\fR, \fB:name\fR, and \fB:development_group\fR options, which control where bundler looks for the \fB\.gemspec\fR, the glob it uses to look for the gemspec (defaults to: "{,\fI,\fR/*}\.gemspec"), what named \fB\.gemspec\fR it uses (if more than one is present), and which group development dependencies are included in\. +. +.P +When a \fBgemspec\fR dependency encounters version conflicts during resolution, the local version under development will always be selected \-\- even if there are remote versions that better match other requirements for the \fBgemspec\fR gem\. +. +.SH "SOURCE PRIORITY" +When attempting to locate a gem to satisfy a gem requirement, bundler uses the following priority order: +. +.IP "1." 4 +The source explicitly attached to the gem (using \fB:source\fR, \fB:path\fR, or \fB:git\fR) +. +.IP "2." 4 +For implicit gems (dependencies of explicit gems), any source, git, or path repository declared on the parent\. This results in bundler prioritizing the ActiveSupport gem from the Rails git repository over ones from \fBrubygems\.org\fR +. +.IP "3." 4 +The sources specified via global \fBsource\fR lines, searching each source in your \fBGemfile\fR from last added to first added\. +. +.IP "" 0 + diff --git a/man/gemfile.5.ronn b/man/gemfile.5.ronn new file mode 100644 index 0000000000..f4772f6d8d --- /dev/null +++ b/man/gemfile.5.ronn @@ -0,0 +1,521 @@ +Gemfile(5) -- A format for describing gem dependencies for Ruby programs +======================================================================== + +## SYNOPSIS + +A `Gemfile` describes the gem dependencies required to execute associated +Ruby code. + +Place the `Gemfile` in the root of the directory containing the associated +code. For instance, in a Rails application, place the `Gemfile` in the same +directory as the `Rakefile`. + +## SYNTAX + +A `Gemfile` is evaluated as Ruby code, in a context which makes available +a number of methods used to describe the gem requirements. + +## GLOBAL SOURCES + +At the top of the `Gemfile`, add a line for the `Rubygems` source that contains +the gems listed in the `Gemfile`. + + source "https://rubygems.org" + +It is possible, but not recommended as of Bundler 1.7, to add multiple global +`source` lines. Each of these `source`s `MUST` be a valid Rubygems repository. + +Sources are checked for gems following the heuristics described in +[SOURCE PRIORITY][]. If a gem is found in more than one global source, Bundler +will print a warning after installing the gem indicating which source was used, +and listing the other sources where the gem is available. A specific source can +be selected for gems that need to use a non-standard repository, suppressing +this warning, by using the [`:source` option](#SOURCE) or a +[`source` block](#BLOCK-FORM-OF-SOURCE-GIT-PATH-GROUP-and-PLATFORMS). + +### CREDENTIALS + +Some gem sources require a username and password. Use [bundle config(1)](bundle-config.1.html) to set +the username and password for any of the sources that need it. The command must +be run once on each computer that will install the Gemfile, but this keeps the +credentials from being stored in plain text in version control. + + bundle config gems.example.com user:password + +For some sources, like a company Gemfury account, it may be easier to +include the credentials in the Gemfile as part of the source URL. + + source "https://user:password@gems.example.com" + +Credentials in the source URL will take precedence over credentials set using +`config`. + +## RUBY + +If your application requires a specific Ruby version or engine, specify your +requirements using the `ruby` method, with the following arguments. +All parameters are `OPTIONAL` unless otherwise specified. + +### VERSION (required) + +The version of Ruby that your application requires. If your application +requires an alternate Ruby engine, such as JRuby, Rubinius or TruffleRuby, this +should be the Ruby version that the engine is compatible with. + + ruby "1.9.3" + +### ENGINE + +Each application _may_ specify a Ruby engine. If an engine is specified, an +engine version _must_ also be specified. + +What exactly is an Engine? + - A Ruby engine is an implementation of the Ruby language. + + - For background: the reference or original implementation of the Ruby + programming language is called + [Matz's Ruby Interpreter](https://en.wikipedia.org/wiki/Ruby_MRI), or MRI + for short. This is named after Ruby creator Yukihiro Matsumoto, + also known as Matz. MRI is also known as CRuby, because it is written in C. + MRI is the most widely used Ruby engine. + + - [Other implementations](https://www.ruby-lang.org/en/about/) of Ruby exist. + Some of the more well-known implementations include + [Rubinius](https://rubinius.com/), and [JRuby](http://jruby.org/). + Rubinius is an alternative implementation of Ruby written in Ruby. + JRuby is an implementation of Ruby on the JVM, short for Java Virtual Machine. + +### ENGINE VERSION + +Each application _may_ specify a Ruby engine version. If an engine version is +specified, an engine _must_ also be specified. If the engine is "ruby" the +engine version specified _must_ match the Ruby version. + + ruby "1.8.7", :engine => "jruby", :engine_version => "1.6.7" + +### PATCHLEVEL + +Each application _may_ specify a Ruby patchlevel. + + ruby "2.0.0", :patchlevel => "247" + +## GEMS + +Specify gem requirements using the `gem` method, with the following arguments. +All parameters are `OPTIONAL` unless otherwise specified. + +### NAME (required) + +For each gem requirement, list a single _gem_ line. + + gem "nokogiri" + +### VERSION + +Each _gem_ `MAY` have one or more version specifiers. + + gem "nokogiri", ">= 1.4.2" + gem "RedCloth", ">= 4.1.0", "< 4.2.0" + +### REQUIRE AS + +Each _gem_ `MAY` specify files that should be used when autorequiring via +`Bundler.require`. You may pass an array with multiple files or `true` if file +you want `required` has same name as _gem_ or `false` to +prevent any file from being autorequired. + + gem "redis", :require => ["redis/connection/hiredis", "redis"] + gem "webmock", :require => false + gem "debugger", :require => true + +The argument defaults to the name of the gem. For example, these are identical: + + gem "nokogiri" + gem "nokogiri", :require => "nokogiri" + gem "nokogiri", :require => true + +### GROUPS + +Each _gem_ `MAY` specify membership in one or more groups. Any _gem_ that does +not specify membership in any group is placed in the `default` group. + + gem "rspec", :group => :test + gem "wirble", :groups => [:development, :test] + +The Bundler runtime allows its two main methods, `Bundler.setup` and +`Bundler.require`, to limit their impact to particular groups. + + # setup adds gems to Ruby's load path + Bundler.setup # defaults to all groups + require "bundler/setup" # same as Bundler.setup + Bundler.setup(:default) # only set up the _default_ group + Bundler.setup(:test) # only set up the _test_ group (but `not` _default_) + Bundler.setup(:default, :test) # set up the _default_ and _test_ groups, but no others + + # require requires all of the gems in the specified groups + Bundler.require # defaults to the _default_ group + Bundler.require(:default) # identical + Bundler.require(:default, :test) # requires the _default_ and _test_ groups + Bundler.require(:test) # requires the _test_ group + +The Bundler CLI allows you to specify a list of groups whose gems `bundle install` should +not install with the `--without` option. To specify multiple groups to ignore, specify a +list of groups separated by spaces. + + bundle install --without test + bundle install --without development test + +After running `bundle install --without test`, bundler will remember that you excluded +the test group in the last installation. The next time you run `bundle install`, +without any `--without option`, bundler will recall it. + +Also, calling `Bundler.setup` with no parameters, or calling `require "bundler/setup"` +will setup all groups except for the ones you excluded via `--without` (since they +are not available). + +Note that on `bundle install`, bundler downloads and evaluates all gems, in order to +create a single canonical list of all of the required gems and their dependencies. +This means that you cannot list different versions of the same gems in different +groups. For more details, see [Understanding Bundler](http://bundler.io/rationale.html). + +### PLATFORMS + +If a gem should only be used in a particular platform or set of platforms, you can +specify them. Platforms are essentially identical to groups, except that you do not +need to use the `--without` install-time flag to exclude groups of gems for other +platforms. + +There are a number of `Gemfile` platforms: + + * `ruby`: + C Ruby (MRI), Rubinius or TruffleRuby, but `NOT` Windows + * `mri`: + Same as _ruby_, but only C Ruby (MRI) + * `mingw`: + Windows 32 bit 'mingw32' platform (aka RubyInstaller) + * `x64_mingw`: + Windows 64 bit 'mingw32' platform (aka RubyInstaller x64) + * `rbx`: + Rubinius + * `jruby`: + JRuby + * `truffleruby`: + TruffleRuby + * `mswin`: + Windows + +You can restrict further by platform and version for all platforms *except* for +`rbx`, `jruby`, `truffleruby` and `mswin`. + +To specify a version in addition to a platform, append the version number without +the delimiter to the platform. For example, to specify that a gem should only be +used on platforms with Ruby 2.3, use: + + ruby_23 + +The full list of platforms and supported versions includes: + + * `ruby`: + 1.8, 1.9, 2.0, 2.1, 2.2, 2.3, 2.4, 2.5 + * `mri`: + 1.8, 1.9, 2.0, 2.1, 2.2, 2.3, 2.4, 2.5 + * `mingw`: + 1.8, 1.9, 2.0, 2.1, 2.2, 2.3, 2.4, 2.5 + * `x64_mingw`: + 2.0, 2.1, 2.2, 2.3, 2.4, 2.5 + +As with groups, you can specify one or more platforms: + + gem "weakling", :platforms => :jruby + gem "ruby-debug", :platforms => :mri_18 + gem "nokogiri", :platforms => [:mri_18, :jruby] + +All operations involving groups ([`bundle install`](bundle-install.1.html), `Bundler.setup`, +`Bundler.require`) behave exactly the same as if any groups not +matching the current platform were explicitly excluded. + +### SOURCE + +You can select an alternate Rubygems repository for a gem using the ':source' +option. + + gem "some_internal_gem", :source => "https://gems.example.com" + +This forces the gem to be loaded from this source and ignores any global sources +declared at the top level of the file. If the gem does not exist in this source, +it will not be installed. + +Bundler will search for child dependencies of this gem by first looking in the +source selected for the parent, but if they are not found there, it will fall +back on global sources using the ordering described in [SOURCE PRIORITY][]. + +Selecting a specific source repository this way also suppresses the ambiguous +gem warning described above in +[GLOBAL SOURCES (#source)](#GLOBAL-SOURCES). + +Using the `:source` option for an individual gem will also make that source +available as a possible global source for any other gems which do not specify +explicit sources. Thus, when adding gems with explicit sources, it is +recommended that you also ensure all other gems in the Gemfile are using +explicit sources. + +### GIT + +If necessary, you can specify that a gem is located at a particular +git repository using the `:git` parameter. The repository can be accessed via +several protocols: + + * `HTTP(S)`: + gem "rails", :git => "https://github.com/rails/rails.git" + * `SSH`: + gem "rails", :git => "git@github.com:rails/rails.git" + * `git`: + gem "rails", :git => "git://github.com/rails/rails.git" + +If using SSH, the user that you use to run `bundle install` `MUST` have the +appropriate keys available in their `$HOME/.ssh`. + +`NOTE`: `http://` and `git://` URLs should be avoided if at all possible. These +protocols are unauthenticated, so a man-in-the-middle attacker can deliver +malicious code and compromise your system. HTTPS and SSH are strongly +preferred. + +The `group`, `platforms`, and `require` options are available and behave +exactly the same as they would for a normal gem. + +A git repository `SHOULD` have at least one file, at the root of the +directory containing the gem, with the extension `.gemspec`. This file +`MUST` contain a valid gem specification, as expected by the `gem build` +command. + +If a git repository does not have a `.gemspec`, bundler will attempt to +create one, but it will not contain any dependencies, executables, or +C extension compilation instructions. As a result, it may fail to properly +integrate into your application. + +If a git repository does have a `.gemspec` for the gem you attached it +to, a version specifier, if provided, means that the git repository is +only valid if the `.gemspec` specifies a version matching the version +specifier. If not, bundler will print a warning. + + gem "rails", "2.3.8", :git => "https://github.com/rails/rails.git" + # bundle install will fail, because the .gemspec in the rails + # repository's master branch specifies version 3.0.0 + +If a git repository does `not` have a `.gemspec` for the gem you attached +it to, a version specifier `MUST` be provided. Bundler will use this +version in the simple `.gemspec` it creates. + +Git repositories support a number of additional options. + + * `branch`, `tag`, and `ref`: + You `MUST` only specify at most one of these options. The default + is `:branch => "master"` + * For example: + + git "https://github.com/rails/rails.git", :branch => "5-0-stable" do + + git "https://github.com/rails/rails.git", :tag => "v5.0.0" do + + git "https://github.com/rails/rails.git", :ref => "4aded" do + + * `submodules`: + For reference, a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) + lets you have another git repository within a subfolder of your repository. + Specify `:submodules => true` to cause bundler to expand any + submodules included in the git repository + +If a git repository contains multiple `.gemspecs`, each `.gemspec` +represents a gem located at the same place in the file system as +the `.gemspec`. + + |~rails [git root] + | |-rails.gemspec [rails gem located here] + |~actionpack + | |-actionpack.gemspec [actionpack gem located here] + |~activesupport + | |-activesupport.gemspec [activesupport gem located here] + |... + +To install a gem located in a git repository, bundler changes to +the directory containing the gemspec, runs `gem build name.gemspec` +and then installs the resulting gem. The `gem build` command, +which comes standard with Rubygems, evaluates the `.gemspec` in +the context of the directory in which it is located. + +### GIT SOURCE + +A custom git source can be defined via the `git_source` method. Provide the source's name +as an argument, and a block which receives a single argument and interpolates it into a +string to return the full repo address: + + git_source(:stash){ |repo_name| "https://stash.corp.acme.pl/#{repo_name}.git" } + gem 'rails', :stash => 'forks/rails' + +In addition, if you wish to choose a specific branch: + + gem "rails", :stash => "forks/rails", :branch => "branch_name" + +### GITHUB + +`NOTE`: This shorthand should be avoided until Bundler 2.0, since it +currently expands to an insecure `git://` URL. This allows a +man-in-the-middle attacker to compromise your system. + +If the git repository you want to use is hosted on GitHub and is public, you can use the +:github shorthand to specify the github username and repository name (without the +trailing ".git"), separated by a slash. If both the username and repository name are the +same, you can omit one. + + gem "rails", :github => "rails/rails" + gem "rails", :github => "rails" + +Are both equivalent to + + gem "rails", :git => "git://github.com/rails/rails.git" + +Since the `github` method is a specialization of `git_source`, it accepts a `:branch` named argument. + +### GIST + +If the git repository you want to use is hosted as a Github Gist and is public, you can use +the :gist shorthand to specify the gist identifier (without the trailing ".git"). + + gem "the_hatch", :gist => "4815162342" + +Is equivalent to: + + gem "the_hatch", :git => "https://gist.github.com/4815162342.git" + +Since the `gist` method is a specialization of `git_source`, it accepts a `:branch` named argument. + +### BITBUCKET + +If the git repository you want to use is hosted on Bitbucket and is public, you can use the +:bitbucket shorthand to specify the bitbucket username and repository name (without the +trailing ".git"), separated by a slash. If both the username and repository name are the +same, you can omit one. + + gem "rails", :bitbucket => "rails/rails" + gem "rails", :bitbucket => "rails" + +Are both equivalent to + + gem "rails", :git => "https://rails@bitbucket.org/rails/rails.git" + +Since the `bitbucket` method is a specialization of `git_source`, it accepts a `:branch` named argument. + +### PATH + +You can specify that a gem is located in a particular location +on the file system. Relative paths are resolved relative to the +directory containing the `Gemfile`. + +Similar to the semantics of the `:git` option, the `:path` +option requires that the directory in question either contains +a `.gemspec` for the gem, or that you specify an explicit +version that bundler should use. + +Unlike `:git`, bundler does not compile C extensions for +gems specified as paths. + + gem "rails", :path => "vendor/rails" + +If you would like to use multiple local gems directly from the filesystem, you can set a global `path` option to the path containing the gem's files. This will automatically load gemspec files from subdirectories. + + path 'components' do + gem 'admin_ui' + gem 'public_ui' + end + +## BLOCK FORM OF SOURCE, GIT, PATH, GROUP and PLATFORMS + +The `:source`, `:git`, `:path`, `:group`, and `:platforms` options may be +applied to a group of gems by using block form. + + source "https://gems.example.com" do + gem "some_internal_gem" + gem "another_internal_gem" + end + + git "https://github.com/rails/rails.git" do + gem "activesupport" + gem "actionpack" + end + + platforms :ruby do + gem "ruby-debug" + gem "sqlite3" + end + + group :development, :optional => true do + gem "wirble" + gem "faker" + end + +In the case of the group block form the :optional option can be given +to prevent a group from being installed unless listed in the `--with` +option given to the `bundle install` command. + +In the case of the `git` block form, the `:ref`, `:branch`, `:tag`, +and `:submodules` options may be passed to the `git` method, and +all gems in the block will inherit those options. + +The presence of a `source` block in a Gemfile also makes that source +available as a possible global source for any other gems which do not specify +explicit sources. Thus, when defining source blocks, it is +recommended that you also ensure all other gems in the Gemfile are using +explicit sources, either via source blocks or `:source` directives on +individual gems. + +## INSTALL_IF + +The `install_if` method allows gems to be installed based on a proc or lambda. +This is especially useful for optional gems that can only be used if certain +software is installed or some other conditions are met. + + install_if -> { RUBY_PLATFORM =~ /darwin/ } do + gem "pasteboard" + end + +## GEMSPEC + +The [`.gemspec`](http://guides.rubygems.org/specification-reference/) file is where + you provide metadata about your gem to Rubygems. Some required Gemspec + attributes include the name, description, and homepage of your gem. This is + also where you specify the dependencies your gem needs to run. + +If you wish to use Bundler to help install dependencies for a gem while it is +being developed, use the `gemspec` method to pull in the dependencies listed in +the `.gemspec` file. + +The `gemspec` method adds any runtime dependencies as gem requirements in the +default group. It also adds development dependencies as gem requirements in the +`development` group. Finally, it adds a gem requirement on your project (`:path +=> '.'`). In conjunction with `Bundler.setup`, this allows you to require project +files in your test code as you would if the project were installed as a gem; you +need not manipulate the load path manually or require project files via relative +paths. + +The `gemspec` method supports optional `:path`, `:glob`, `:name`, and `:development_group` +options, which control where bundler looks for the `.gemspec`, the glob it uses to look +for the gemspec (defaults to: "{,*,*/*}.gemspec"), what named `.gemspec` it uses +(if more than one is present), and which group development dependencies are included in. + +When a `gemspec` dependency encounters version conflicts during resolution, the +local version under development will always be selected -- even if there are +remote versions that better match other requirements for the `gemspec` gem. + +## SOURCE PRIORITY + +When attempting to locate a gem to satisfy a gem requirement, +bundler uses the following priority order: + + 1. The source explicitly attached to the gem (using `:source`, `:path`, or + `:git`) + 2. For implicit gems (dependencies of explicit gems), any source, git, or path + repository declared on the parent. This results in bundler prioritizing the + ActiveSupport gem from the Rails git repository over ones from + `rubygems.org` + 3. The sources specified via global `source` lines, searching each source in + your `Gemfile` from last added to first added. diff --git a/man/gemfile.5.txt b/man/gemfile.5.txt new file mode 100644 index 0000000000..0ff77795ad --- /dev/null +++ b/man/gemfile.5.txt @@ -0,0 +1,653 @@ +GEMFILE(5) GEMFILE(5) + + + +1mNAME0m + 1mGemfile 22m- A format for describing gem dependencies for Ruby programs + +1mSYNOPSIS0m + A 1mGemfile 22mdescribes the gem dependencies required to execute associated + Ruby code. + + Place the 1mGemfile 22min the root of the directory containing the associ- + ated code. For instance, in a Rails application, place the 1mGemfile 22min + the same directory as the 1mRakefile22m. + +1mSYNTAX0m + A 1mGemfile 22mis evaluated as Ruby code, in a context which makes available + a number of methods used to describe the gem requirements. + +1mGLOBAL SOURCES0m + At the top of the 1mGemfile22m, add a line for the 1mRubygems 22msource that con- + tains the gems listed in the 1mGemfile22m. + + + + source "https://rubygems.org" + + + + It is possible, but not recommended as of Bundler 1.7, to add multiple + global 1msource 22mlines. Each of these 1msource22ms 1mMUST 22mbe a valid Rubygems + repository. + + Sources are checked for gems following the heuristics described in + 4mSOURCE24m 4mPRIORITY24m. If a gem is found in more than one global source, + Bundler will print a warning after installing the gem indicating which + source was used, and listing the other sources where the gem is avail- + able. A specific source can be selected for gems that need to use a + non-standard repository, suppressing this warning, by using the 1m:source0m + option or a 1msource 22mblock. + + 1mCREDENTIALS0m + Some gem sources require a username and password. Use bundle config(1) + 4mbundle-config.1.html24m to set the username and password for any of the + sources that need it. The command must be run once on each computer + that will install the Gemfile, but this keeps the credentials from + being stored in plain text in version control. + + + + bundle config gems.example.com user:password + + + + For some sources, like a company Gemfury account, it may be easier to + include the credentials in the Gemfile as part of the source URL. + + + + source "https://user:password@gems.example.com" + + + + Credentials in the source URL will take precedence over credentials set + using 1mconfig22m. + +1mRUBY0m + If your application requires a specific Ruby version or engine, specify + your requirements using the 1mruby 22mmethod, with the following arguments. + All parameters are 1mOPTIONAL 22munless otherwise specified. + + 1mVERSION (required)0m + The version of Ruby that your application requires. If your application + requires an alternate Ruby engine, such as JRuby, Rubinius or Truf- + fleRuby, this should be the Ruby version that the engine is compatible + with. + + + + ruby "1.9.3" + + + + 1mENGINE0m + Each application 4mmay24m specify a Ruby engine. If an engine is specified, + an engine version 4mmust24m also be specified. + + What exactly is an Engine? - A Ruby engine is an implementation of the + Ruby language. + + o For background: the reference or original implementation of the + Ruby programming language is called Matz's Ruby Interpreter + 4mhttps://en.wikipedia.org/wiki/Ruby_MRI24m, or MRI for short. This is + named after Ruby creator Yukihiro Matsumoto, also known as Matz. + MRI is also known as CRuby, because it is written in C. MRI is the + most widely used Ruby engine. + + o Other implementations 4mhttps://www.ruby-lang.org/en/about/24m of Ruby + exist. Some of the more well-known implementations include Rubinius + 4mhttps://rubinius.com/24m, and JRuby 4mhttp://jruby.org/24m. Rubinius is an + alternative implementation of Ruby written in Ruby. JRuby is an + implementation of Ruby on the JVM, short for Java Virtual Machine. + + + + 1mENGINE VERSION0m + Each application 4mmay24m specify a Ruby engine version. If an engine ver- + sion is specified, an engine 4mmust24m also be specified. If the engine is + "ruby" the engine version specified 4mmust24m match the Ruby version. + + + + ruby "1.8.7", :engine => "jruby", :engine_version => "1.6.7" + + + + 1mPATCHLEVEL0m + Each application 4mmay24m specify a Ruby patchlevel. + + + + ruby "2.0.0", :patchlevel => "247" + + + +1mGEMS0m + Specify gem requirements using the 1mgem 22mmethod, with the following argu- + ments. All parameters are 1mOPTIONAL 22munless otherwise specified. + + 1mNAME (required)0m + For each gem requirement, list a single 4mgem24m line. + + + + gem "nokogiri" + + + + 1mVERSION0m + Each 4mgem24m 1mMAY 22mhave one or more version specifiers. + + + + gem "nokogiri", ">= 1.4.2" + gem "RedCloth", ">= 4.1.0", "< 4.2.0" + + + + 1mREQUIRE AS0m + Each 4mgem24m 1mMAY 22mspecify files that should be used when autorequiring via + 1mBundler.require22m. You may pass an array with multiple files or 1mtrue 22mif + file you want 1mrequired 22mhas same name as 4mgem24m or 1mfalse 22mto prevent any + file from being autorequired. + + + + gem "redis", :require => ["redis/connection/hiredis", "redis"] + gem "webmock", :require => false + gem "debugger", :require => true + + + + The argument defaults to the name of the gem. For example, these are + identical: + + + + gem "nokogiri" + gem "nokogiri", :require => "nokogiri" + gem "nokogiri", :require => true + + + + 1mGROUPS0m + Each 4mgem24m 1mMAY 22mspecify membership in one or more groups. Any 4mgem24m that + does not specify membership in any group is placed in the 1mdefault0m + group. + + + + gem "rspec", :group => :test + gem "wirble", :groups => [:development, :test] + + + + The Bundler runtime allows its two main methods, 1mBundler.setup 22mand + 1mBundler.require22m, to limit their impact to particular groups. + + + + # setup adds gems to Ruby's load path + Bundler.setup # defaults to all groups + require "bundler/setup" # same as Bundler.setup + Bundler.setup(:default) # only set up the _default_ group + Bundler.setup(:test) # only set up the _test_ group (but `not` _default_) + Bundler.setup(:default, :test) # set up the _default_ and _test_ groups, but no others + + # require requires all of the gems in the specified groups + Bundler.require # defaults to the _default_ group + Bundler.require(:default) # identical + Bundler.require(:default, :test) # requires the _default_ and _test_ groups + Bundler.require(:test) # requires the _test_ group + + + + The Bundler CLI allows you to specify a list of groups whose gems 1mbun-0m + 1mdle install 22mshould not install with the 1m--without 22moption. To specify + multiple groups to ignore, specify a list of groups separated by spa- + ces. + + + + bundle install --without test + bundle install --without development test + + + + After running 1mbundle install --without test22m, bundler will remember that + you excluded the test group in the last installation. The next time you + run 1mbundle install22m, without any 1m--without option22m, bundler will recall + it. + + Also, calling 1mBundler.setup 22mwith no parameters, or calling 1mrequire0m + 1m"bundler/setup" 22mwill setup all groups except for the ones you excluded + via 1m--without 22m(since they are not available). + + Note that on 1mbundle install22m, bundler downloads and evaluates all gems, + in order to create a single canonical list of all of the required gems + and their dependencies. This means that you cannot list different ver- + sions of the same gems in different groups. For more details, see + Understanding Bundler 4mhttp://bundler.io/rationale.html24m. + + 1mPLATFORMS0m + If a gem should only be used in a particular platform or set of plat- + forms, you can specify them. Platforms are essentially identical to + groups, except that you do not need to use the 1m--without 22minstall-time + flag to exclude groups of gems for other platforms. + + There are a number of 1mGemfile 22mplatforms: + + 1mruby 22mC Ruby (MRI), Rubinius or TruffleRuby, but 1mNOT 22mWindows + + 1mmri 22mSame as 4mruby24m, but only C Ruby (MRI) + + 1mmingw 22mWindows 32 bit 'mingw32' platform (aka RubyInstaller) + + 1mx64_mingw0m + Windows 64 bit 'mingw32' platform (aka RubyInstaller x64) + + 1mrbx 22mRubinius + + 1mjruby 22mJRuby + + 1mtruffleruby0m + TruffleRuby + + 1mmswin 22mWindows + + You can restrict further by platform and version for all platforms + 4mexcept24m for 1mrbx22m, 1mjruby22m, 1mtruffleruby 22mand 1mmswin22m. + + To specify a version in addition to a platform, append the version num- + ber without the delimiter to the platform. For example, to specify that + a gem should only be used on platforms with Ruby 2.3, use: + + + + ruby_23 + + + + The full list of platforms and supported versions includes: + + 1mruby 22m1.8, 1.9, 2.0, 2.1, 2.2, 2.3, 2.4, 2.5 + + 1mmri 22m1.8, 1.9, 2.0, 2.1, 2.2, 2.3, 2.4, 2.5 + + 1mmingw 22m1.8, 1.9, 2.0, 2.1, 2.2, 2.3, 2.4, 2.5 + + 1mx64_mingw0m + 2.0, 2.1, 2.2, 2.3, 2.4, 2.5 + + As with groups, you can specify one or more platforms: + + + + gem "weakling", :platforms => :jruby + gem "ruby-debug", :platforms => :mri_18 + gem "nokogiri", :platforms => [:mri_18, :jruby] + + + + All operations involving groups (1mbundle install 4m22mbundle-install.1.html24m, + 1mBundler.setup22m, 1mBundler.require22m) behave exactly the same as if any + groups not matching the current platform were explicitly excluded. + + 1mSOURCE0m + You can select an alternate Rubygems repository for a gem using the + ':source' option. + + + + gem "some_internal_gem", :source => "https://gems.example.com" + + + + This forces the gem to be loaded from this source and ignores any + global sources declared at the top level of the file. If the gem does + not exist in this source, it will not be installed. + + Bundler will search for child dependencies of this gem by first looking + in the source selected for the parent, but if they are not found there, + it will fall back on global sources using the ordering described in + 4mSOURCE24m 4mPRIORITY24m. + + Selecting a specific source repository this way also suppresses the + ambiguous gem warning described above in 4mGLOBAL24m 4mSOURCES24m 4m(#source)24m. + + Using the 1m:source 22moption for an individual gem will also make that + source available as a possible global source for any other gems which + do not specify explicit sources. Thus, when adding gems with explicit + sources, it is recommended that you also ensure all other gems in the + Gemfile are using explicit sources. + + 1mGIT0m + If necessary, you can specify that a gem is located at a particular git + repository using the 1m:git 22mparameter. The repository can be accessed via + several protocols: + + 1mHTTP(S)0m + gem "rails", :git => "https://github.com/rails/rails.git" + + 1mSSH 22mgem "rails", :git => "git@github.com:rails/rails.git" + + 1mgit 22mgem "rails", :git => "git://github.com/rails/rails.git" + + If using SSH, the user that you use to run 1mbundle install MUST 22mhave the + appropriate keys available in their 1m$HOME/.ssh22m. + + 1mNOTE22m: 1mhttp:// 22mand 1mgit:// 22mURLs should be avoided if at all possible. + These protocols are unauthenticated, so a man-in-the-middle attacker + can deliver malicious code and compromise your system. HTTPS and SSH + are strongly preferred. + + The 1mgroup22m, 1mplatforms22m, and 1mrequire 22moptions are available and behave + exactly the same as they would for a normal gem. + + A git repository 1mSHOULD 22mhave at least one file, at the root of the + directory containing the gem, with the extension 1m.gemspec22m. This file + 1mMUST 22mcontain a valid gem specification, as expected by the 1mgem build0m + command. + + If a git repository does not have a 1m.gemspec22m, bundler will attempt to + create one, but it will not contain any dependencies, executables, or C + extension compilation instructions. As a result, it may fail to prop- + erly integrate into your application. + + If a git repository does have a 1m.gemspec 22mfor the gem you attached it + to, a version specifier, if provided, means that the git repository is + only valid if the 1m.gemspec 22mspecifies a version matching the version + specifier. If not, bundler will print a warning. + + + + gem "rails", "2.3.8", :git => "https://github.com/rails/rails.git" + # bundle install will fail, because the .gemspec in the rails + # repository's master branch specifies version 3.0.0 + + + + If a git repository does 1mnot 22mhave a 1m.gemspec 22mfor the gem you attached + it to, a version specifier 1mMUST 22mbe provided. Bundler will use this ver- + sion in the simple 1m.gemspec 22mit creates. + + Git repositories support a number of additional options. + + 1mbranch22m, 1mtag22m, and 1mref0m + You 1mMUST 22monly specify at most one of these options. The default + is 1m:branch => "master"0m + + For example: + + git "https://github.com/rails/rails.git", :branch => "5-0-sta- + ble" do + + git "https://github.com/rails/rails.git", :tag => "v5.0.0" do + + git "https://github.com/rails/rails.git", :ref => "4aded" do + + 1msubmodules0m + For reference, a git submodule + 4mhttps://git-scm.com/book/en/v2/Git-Tools-Submodules24m lets you + have another git repository within a subfolder of your reposi- + tory. Specify 1m:submodules => true 22mto cause bundler to expand any + submodules included in the git repository + + If a git repository contains multiple 1m.gemspecs22m, each 1m.gemspec 22mrepre- + sents a gem located at the same place in the file system as the 1m.gem-0m + 1mspec22m. + + + + |~rails [git root] + | |-rails.gemspec [rails gem located here] + |~actionpack + | |-actionpack.gemspec [actionpack gem located here] + |~activesupport + | |-activesupport.gemspec [activesupport gem located here] + |... + + + + To install a gem located in a git repository, bundler changes to the + directory containing the gemspec, runs 1mgem build name.gemspec 22mand then + installs the resulting gem. The 1mgem build 22mcommand, which comes standard + with Rubygems, evaluates the 1m.gemspec 22min the context of the directory + in which it is located. + + 1mGIT SOURCE0m + A custom git source can be defined via the 1mgit_source 22mmethod. Provide + the source's name as an argument, and a block which receives a single + argument and interpolates it into a string to return the full repo + address: + + + + git_source(:stash){ |repo_name| "https://stash.corp.acme.pl/#{repo_name}.git" } + gem 'rails', :stash => 'forks/rails' + + + + In addition, if you wish to choose a specific branch: + + + + gem "rails", :stash => "forks/rails", :branch => "branch_name" + + + + 1mGITHUB0m + 1mNOTE22m: This shorthand should be avoided until Bundler 2.0, since it cur- + rently expands to an insecure 1mgit:// 22mURL. This allows a man-in-the-mid- + dle attacker to compromise your system. + + If the git repository you want to use is hosted on GitHub and is pub- + lic, you can use the :github shorthand to specify the github username + and repository name (without the trailing ".git"), separated by a + slash. If both the username and repository name are the same, you can + omit one. + + + + gem "rails", :github => "rails/rails" + gem "rails", :github => "rails" + + + + Are both equivalent to + + + + gem "rails", :git => "git://github.com/rails/rails.git" + + + + Since the 1mgithub 22mmethod is a specialization of 1mgit_source22m, it accepts a + 1m:branch 22mnamed argument. + + 1mGIST0m + If the git repository you want to use is hosted as a Github Gist and is + public, you can use the :gist shorthand to specify the gist identifier + (without the trailing ".git"). + + + + gem "the_hatch", :gist => "4815162342" + + + + Is equivalent to: + + + + gem "the_hatch", :git => "https://gist.github.com/4815162342.git" + + + + Since the 1mgist 22mmethod is a specialization of 1mgit_source22m, it accepts a + 1m:branch 22mnamed argument. + + 1mBITBUCKET0m + If the git repository you want to use is hosted on Bitbucket and is + public, you can use the :bitbucket shorthand to specify the bitbucket + username and repository name (without the trailing ".git"), separated + by a slash. If both the username and repository name are the same, you + can omit one. + + + + gem "rails", :bitbucket => "rails/rails" + gem "rails", :bitbucket => "rails" + + + + Are both equivalent to + + + + gem "rails", :git => "https://rails@bitbucket.org/rails/rails.git" + + + + Since the 1mbitbucket 22mmethod is a specialization of 1mgit_source22m, it + accepts a 1m:branch 22mnamed argument. + + 1mPATH0m + You can specify that a gem is located in a particular location on the + file system. Relative paths are resolved relative to the directory con- + taining the 1mGemfile22m. + + Similar to the semantics of the 1m:git 22moption, the 1m:path 22moption requires + that the directory in question either contains a 1m.gemspec 22mfor the gem, + or that you specify an explicit version that bundler should use. + + Unlike 1m:git22m, bundler does not compile C extensions for gems specified + as paths. + + + + gem "rails", :path => "vendor/rails" + + + + If you would like to use multiple local gems directly from the filesys- + tem, you can set a global 1mpath 22moption to the path containing the gem's + files. This will automatically load gemspec files from subdirectories. + + + + path 'components' do + gem 'admin_ui' + gem 'public_ui' + end + + + +1mBLOCK FORM OF SOURCE, GIT, PATH, GROUP and PLATFORMS0m + The 1m:source22m, 1m:git22m, 1m:path22m, 1m:group22m, and 1m:platforms 22moptions may be applied + to a group of gems by using block form. + + + + source "https://gems.example.com" do + gem "some_internal_gem" + gem "another_internal_gem" + end + + git "https://github.com/rails/rails.git" do + gem "activesupport" + gem "actionpack" + end + + platforms :ruby do + gem "ruby-debug" + gem "sqlite3" + end + + group :development, :optional => true do + gem "wirble" + gem "faker" + end + + + + In the case of the group block form the :optional option can be given + to prevent a group from being installed unless listed in the 1m--with0m + option given to the 1mbundle install 22mcommand. + + In the case of the 1mgit 22mblock form, the 1m:ref22m, 1m:branch22m, 1m:tag22m, and 1m:sub-0m + 1mmodules 22moptions may be passed to the 1mgit 22mmethod, and all gems in the + block will inherit those options. + + The presence of a 1msource 22mblock in a Gemfile also makes that source + available as a possible global source for any other gems which do not + specify explicit sources. Thus, when defining source blocks, it is rec- + ommended that you also ensure all other gems in the Gemfile are using + explicit sources, either via source blocks or 1m:source 22mdirectives on + individual gems. + +1mINSTALL_IF0m + The 1minstall_if 22mmethod allows gems to be installed based on a proc or + lambda. This is especially useful for optional gems that can only be + used if certain software is installed or some other conditions are met. + + + + install_if -> { RUBY_PLATFORM =~ /darwin/ } do + gem "pasteboard" + end + + + +1mGEMSPEC0m + The 1m.gemspec 4m22mhttp://guides.rubygems.org/specification-reference/24m file + is where you provide metadata about your gem to Rubygems. Some required + Gemspec attributes include the name, description, and homepage of your + gem. This is also where you specify the dependencies your gem needs to + run. + + If you wish to use Bundler to help install dependencies for a gem while + it is being developed, use the 1mgemspec 22mmethod to pull in the dependen- + cies listed in the 1m.gemspec 22mfile. + + The 1mgemspec 22mmethod adds any runtime dependencies as gem requirements in + the default group. It also adds development dependencies as gem + requirements in the 1mdevelopment 22mgroup. Finally, it adds a gem require- + ment on your project (1m:path => '.'22m). In conjunction with 1mBundler.setup22m, + this allows you to require project files in your test code as you would + if the project were installed as a gem; you need not manipulate the + load path manually or require project files via relative paths. + + The 1mgemspec 22mmethod supports optional 1m:path22m, 1m:glob22m, 1m:name22m, and 1m:develop-0m + 1mment_group 22moptions, which control where bundler looks for the 1m.gemspec22m, + the glob it uses to look for the gemspec (defaults to: "{,4m,24m/*}.gem- + spec"), what named 1m.gemspec 22mit uses (if more than one is present), and + which group development dependencies are included in. + + When a 1mgemspec 22mdependency encounters version conflicts during resolu- + tion, the local version under development will always be selected -- + even if there are remote versions that better match other requirements + for the 1mgemspec 22mgem. + +1mSOURCE PRIORITY0m + When attempting to locate a gem to satisfy a gem requirement, bundler + uses the following priority order: + + 1. The source explicitly attached to the gem (using 1m:source22m, 1m:path22m, or + 1m:git22m) + + 2. For implicit gems (dependencies of explicit gems), any source, git, + or path repository declared on the parent. This results in bundler + prioritizing the ActiveSupport gem from the Rails git repository + over ones from 1mrubygems.org0m + + 3. The sources specified via global 1msource 22mlines, searching each + source in your 1mGemfile 22mfrom last added to first added. + + + + + + + October 2018 GEMFILE(5) |