bundler 2.3.12 → 2.4.6

data/lib/bundler/man/gemfile.5

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GEMFILE" "5" "March 2022" "" ""
+.TH "GEMFILE" "5" "January 2023" "" ""
 .
 .SH "NAME"
 \fBGemfile\fR \- A format for describing gem dependencies for Ruby programs
@@ -15,8 +15,8 @@ Place the \fBGemfile\fR in the root of the directory containing the associated c
 .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\.
+.SH "GLOBAL SOURCE"
+At the top of the \fBGemfile\fR, add a single line for the \fBRubyGems\fR source that contains the gems listed in the \fBGemfile\fR\.
 .
 .IP "" 4
 .
@@ -29,10 +29,16 @@ source "https://rubygems\.org"
 .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\.
+You can add only one global source\. In Bundler 1\.13, adding multiple global sources was deprecated\. The \fBsource\fR \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\.
+To use more than one source of RubyGems, you should use \fI\fBsource\fR block\fR\.
+.
+.P
+A source is checked for gems following the heuristics described in \fISOURCE PRIORITY\fR\.
+.
+.P
+\fBNote about a behavior of the feature deprecated in Bundler 1\.13\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 \fBsource\fR block\.
 .
 .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\.
@@ -67,13 +73,13 @@ Credentials in the source URL will take precedence over credentials set using \f
 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\.
+The version of Ruby that your application requires\. If your application requires an alternate Ruby engine, such as JRuby, TruffleRuby, etc\., this should be the Ruby version that the engine is compatible with\.
 .
 .IP "" 4
 .
 .nf
 
-ruby "1\.9\.3"
+ruby "3\.1\.2"
 .
 .fi
 .
@@ -89,7 +95,7 @@ What exactly is an Engine? \- A Ruby engine is an implementation of the Ruby lan
 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\.
+Other implementations \fIhttps://www\.ruby\-lang\.org/en/about/\fR of Ruby exist\. Some of the more well\-known implementations include JRuby \fIhttp://jruby\.org/\fR and TruffleRuby \fIhttps://www\.graalvm\.org/ruby/\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\. TruffleRuby is a Ruby implementation on the GraalVM, a language toolkit built on the JVM\.
 .
 .IP "" 0
 .
@@ -100,20 +106,23 @@ Each application \fImay\fR specify a Ruby engine version\. If an engine version
 .
 .nf
 
-ruby "1\.8\.7", :engine => "jruby", :engine_version => "1\.6\.7"
+ruby "2\.6\.8", engine: "jruby", engine_version: "9\.3\.8\.0"
 .
 .fi
 .
 .IP "" 0
 .
 .SS "PATCHLEVEL"
-Each application \fImay\fR specify a Ruby patchlevel\.
+Each application \fImay\fR specify a Ruby patchlevel\. Specifying the patchlevel has been meaningless since Ruby 2\.1\.0 was released as the patchlevel is now uniquely determined by a combination of major, minor, and teeny version numbers\.
+.
+.P
+This option was implemented in Bundler 1\.4\.0 for Ruby 2\.0 or earlier\.
 .
 .IP "" 4
 .
 .nf
 
-ruby "2\.0\.0", :patchlevel => "247"
+ruby "3\.1\.2", patchlevel: "20"
 .
 .fi
 .
@@ -156,9 +165,9 @@ Each \fIgem\fR \fBMAY\fR specify files that should be used when autorequiring vi
 .
 .nf
 
-gem "redis", :require => ["redis/connection/hiredis", "redis"]
-gem "webmock", :require => false
-gem "byebug", :require => true
+gem "redis", require: ["redis/connection/hiredis", "redis"]
+gem "webmock", require: false
+gem "byebug", require: true
 .
 .fi
 .
@@ -172,8 +181,8 @@ The argument defaults to the name of the gem\. For example, these are identical:
 .nf
 
 gem "nokogiri"
-gem "nokogiri", :require => "nokogiri"
-gem "nokogiri", :require => true
+gem "nokogiri", require: "nokogiri"
+gem "nokogiri", require: true
 .
 .fi
 .
@@ -186,8 +195,8 @@ Each \fIgem\fR \fBMAY\fR specify membership in one or more groups\. Any \fIgem\f
 .
 .nf
 
-gem "rspec", :group => :test
-gem "wirble", :groups => [:development, :test]
+gem "rspec", group: :test
+gem "wirble", groups: [:development, :test]
 .
 .fi
 .
@@ -248,19 +257,23 @@ There are a number of \fBGemfile\fR platforms:
 .
 .TP
 \fBruby\fR
-C Ruby (MRI), Rubinius or TruffleRuby, but \fBNOT\fR Windows
+C Ruby (MRI), Rubinius, or TruffleRuby, but not Windows
 .
 .TP
 \fBmri\fR
-Same as \fIruby\fR, but only C Ruby (MRI)
+C Ruby (MRI) only, but not Windows
+.
+.TP
+\fBwindows\fR
+Windows C Ruby (MRI), including RubyInstaller 32\-bit and 64\-bit versions
 .
 .TP
-\fBmingw\fR
-Windows 32 bit \'mingw32\' platform (aka RubyInstaller)
+\fBmswin\fR
+Windows C Ruby (MRI), including RubyInstaller 32\-bit versions
 .
 .TP
-\fBx64_mingw\fR
-Windows 64 bit \'mingw32\' platform (aka RubyInstaller x64)
+\fBmswin64\fR
+Windows C Ruby (MRI), including RubyInstaller 64\-bit versions
 .
 .TP
 \fBrbx\fR
@@ -274,84 +287,82 @@ JRuby
 \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:
+On platforms \fBruby\fR, \fBmri\fR, \fBmswin\fR, \fBmswin64\fR, and \fBwindows\fR, you may additionally specify a version by appending the major and minor version numbers without a delimiter\. For example, to specify that a gem should only be used on platform \fBruby\fR version 3\.1, use:
 .
 .IP "" 4
 .
 .nf
 
-ruby_23
+ruby_31
 .
 .fi
 .
 .IP "" 0
 .
 .P
-The full list of platforms and supported versions includes:
+As with groups (above), you may specify one or more platforms:
 .
-.TP
-\fBruby\fR
-1\.8, 1\.9, 2\.0, 2\.1, 2\.2, 2\.3, 2\.4, 2\.5, 2\.6
+.IP "" 4
 .
-.TP
-\fBmri\fR
-1\.8, 1\.9, 2\.0, 2\.1, 2\.2, 2\.3, 2\.4, 2\.5, 2\.6
+.nf
+
+gem "weakling",   platforms: :jruby
+gem "ruby\-debug", platforms: :mri_31
+gem "nokogiri",   platforms: [:windows_31, :jruby]
 .
-.TP
-\fBmingw\fR
-1\.8, 1\.9, 2\.0, 2\.1, 2\.2, 2\.3, 2\.4, 2\.5, 2\.6
+.fi
 .
-.TP
-\fBx64_mingw\fR
-2\.0, 2\.1, 2\.2, 2\.3, 2\.4, 2\.5, 2\.6
+.IP "" 0
 .
 .P
-As with groups, you can specify one or more platforms:
+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 "FORCE_RUBY_PLATFORM"
+If you always want the pure ruby variant of a gem to be chosen over platform specific variants, you can use the \fBforce_ruby_platform\fR option:
 .
 .IP "" 4
 .
 .nf
 
-gem "weakling",   :platforms => :jruby
-gem "ruby\-debug", :platforms => :mri_18
-gem "nokogiri",   :platforms => [:mri_18, :jruby]
+gem "ffi", force_ruby_platform: true
 .
 .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\.
+This can be handy (assuming the pure ruby variant works fine) when:
+.
+.IP "\(bu" 4
+You\'re having issues with the platform specific variant\.
+.
+.IP "\(bu" 4
+The platform specific variant does not yet support a newer ruby (and thus has a \fBrequired_ruby_version\fR upper bound), but you still want your Gemfile{\.lock} files to resolve under that ruby\.
+.
+.IP "" 0
 .
 .SS "SOURCE"
-You can select an alternate Rubygems repository for a gem using the \':source\' option\.
+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"
+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\.
+This forces the gem to be loaded from this source and ignores the global source 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\.
+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 the global source\.
 .
 .P
-Selecting a specific source repository this way also suppresses the ambiguous gem warning described above in \fIGLOBAL SOURCES (#source)\fR\.
+\fBNote about a behavior of the feature deprecated in Bundler 1\.13\fR: Selecting a specific source repository this way also suppresses the ambiguous gem warning described above in \fIGLOBAL 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\.
@@ -361,15 +372,15 @@ If necessary, you can specify that a gem is located at a particular git reposito
 .
 .TP
 \fBHTTP(S)\fR
-gem "rails", :git => "https://github\.com/rails/rails\.git"
+gem "rails", git: "https://github\.com/rails/rails\.git"
 .
 .TP
 \fBSSH\fR
-gem "rails", :git => "git@github\.com:rails/rails\.git"
+gem "rails", git: "git@github\.com:rails/rails\.git"
 .
 .TP
 \fBgit\fR
-gem "rails", :git => "git://github\.com/rails/rails\.git"
+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\.
@@ -393,7 +404,7 @@ If a git repository does have a \fB\.gemspec\fR for the gem you attached it to,
 .
 .nf
 
-gem "rails", "2\.3\.8", :git => "https://github\.com/rails/rails\.git"
+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
 .
@@ -409,20 +420,20 @@ 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\. For example:
+You \fBMUST\fR only specify at most one of these options\. The default is \fBbranch: "master"\fR\. For example:
 .
 .IP
-gem "rails", :git => "https://github\.com/rails/rails\.git", :branch => "5\-0\-stable"
+gem "rails", git: "https://github\.com/rails/rails\.git", branch: "5\-0\-stable"
 .
 .IP
-gem "rails", :git => "https://github\.com/rails/rails\.git", :tag => "v5\.0\.0"
+gem "rails", git: "https://github\.com/rails/rails\.git", tag: "v5\.0\.0"
 .
 .IP
-gem "rails", :git => "https://github\.com/rails/rails\.git", :ref => "4aded"
+gem "rails", git: "https://github\.com/rails/rails\.git", ref: "4aded"
 .
 .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
+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 \fBsubmodules: 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\.
@@ -454,7 +465,7 @@ A custom git source can be defined via the \fBgit_source\fR method\. Provide the
 .nf
 
 git_source(:stash){ |repo_name| "https://stash\.corp\.acme\.pl/#{repo_name}\.git" }
-gem \'rails\', :stash => \'forks/rails\'
+gem \'rails\', stash: \'forks/rails\'
 .
 .fi
 .
@@ -467,7 +478,7 @@ In addition, if you wish to choose a specific branch:
 .
 .nf
 
-gem "rails", :stash => "forks/rails", :branch => "branch_name"
+gem "rails", stash: "forks/rails", branch: "branch_name"
 .
 .fi
 .
@@ -483,8 +494,8 @@ If the git repository you want to use is hosted on GitHub and is public, you can
 .
 .nf
 
-gem "rails", :github => "rails/rails"
-gem "rails", :github => "rails"
+gem "rails", github: "rails/rails"
+gem "rails", github: "rails"
 .
 .fi
 .
@@ -497,7 +508,7 @@ Are both equivalent to
 .
 .nf
 
-gem "rails", :git => "git://github\.com/rails/rails\.git"
+gem "rails", git: "https://github\.com/rails/rails\.git"
 .
 .fi
 .
@@ -513,7 +524,7 @@ You can also directly pass a pull request URL:
 .
 .nf
 
-gem "rails", :github => "https://github\.com/rails/rails/pull/43753"
+gem "rails", github: "https://github\.com/rails/rails/pull/43753"
 .
 .fi
 .
@@ -526,7 +537,7 @@ Which is equivalent to:
 .
 .nf
 
-gem "rails", :github => "rails/rails", branch: "refs/pull/43753/head"
+gem "rails", github: "rails/rails", branch: "refs/pull/43753/head"
 .
 .fi
 .
@@ -539,7 +550,7 @@ If the git repository you want to use is hosted as a GitHub Gist and is public,
 .
 .nf
 
-gem "the_hatch", :gist => "4815162342"
+gem "the_hatch", gist: "4815162342"
 .
 .fi
 .
@@ -552,7 +563,7 @@ Is equivalent to:
 .
 .nf
 
-gem "the_hatch", :git => "https://gist\.github\.com/4815162342\.git"
+gem "the_hatch", git: "https://gist\.github\.com/4815162342\.git"
 .
 .fi
 .
@@ -568,8 +579,8 @@ If the git repository you want to use is hosted on Bitbucket and is public, you
 .
 .nf
 
-gem "rails", :bitbucket => "rails/rails"
-gem "rails", :bitbucket => "rails"
+gem "rails", bitbucket: "rails/rails"
+gem "rails", bitbucket: "rails"
 .
 .fi
 .
@@ -582,7 +593,7 @@ Are both equivalent to
 .
 .nf
 
-gem "rails", :git => "https://rails@bitbucket\.org/rails/rails\.git"
+gem "rails", git: "https://rails@bitbucket\.org/rails/rails\.git"
 .
 .fi
 .
@@ -604,7 +615,7 @@ Unlike \fB:git\fR, bundler does not compile C extensions for gems specified as p
 .
 .nf
 
-gem "rails", :path => "vendor/rails"
+gem "rails", path: "vendor/rails"
 .
 .fi
 .
@@ -648,7 +659,7 @@ platforms :ruby do
   gem "sqlite3"
 end
 
-group :development, :optional => true do
+group :development, optional: true do
   gem "wirble"
   gem "faker"
 end
@@ -688,7 +699,7 @@ The \fB\.gemspec\fR \fIhttp://guides\.rubygems\.org/specification\-reference/\fR
 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\.
+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 (\fBpath: \'\.\'\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\.
@@ -706,7 +717,7 @@ The source explicitly attached to the gem (using \fB:source\fR, \fB:path\fR, or
 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\.
+If neither of the above conditions are met, the global source will be used\. If multiple global sources are specified, they will be prioritized from last to first, but this is deprecated since Bundler 1\.13, so Bundler prints a warning and will abort with an error in the future\.
 .
 .IP "" 0