bundler 1.15.2 → 1.17.3

data/man/bundle.ronn

@@ -18,78 +18,84 @@ started, and Gemfile(5) for more information on the `Gemfile` format.
 * `--no-color`:
   Print all output without color
 
-* `--verbose`:
+* `--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.
+We divide `bundle` subcommands into primary commands and utilities:
 
 ## PRIMARY COMMANDS
 
-* [`bundle install(1)`][bundle-install]:
+* [`bundle install(1)`](bundle-install.1.html):
   Install the gems specified by the `Gemfile` or `Gemfile.lock`
 
-* [`bundle update(1)`][bundle-update]:
+* [`bundle update(1)`](bundle-update.1.html):
   Update dependencies to their latest versions
 
-* [`bundle package(1)`][bundle-package]:
+* [`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]:
-  Execute a script in the context of the current bundle
+* [`bundle exec(1)`](bundle-exec.1.html):
+  Execute a script in the current bundle
 
-* [`bundle config(1)`][bundle-config]:
-  Specify and read configuration options for bundler
+* [`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)`](bundle-add.1.html):
   Add the named gem to the Gemfile and run `bundle install`
 
-* `bundle binstubs(1)`:
+* [`bundle binstubs(1)`](bundle-binstubs.1.html):
   Generate binstubs for executables in a gem
 
-* `bundle check(1)`:
+* [`bundle check(1)`](bundle-check.1.html):
   Determine whether the requirements for your application are installed
-  and available to bundler
+  and available to Bundler
 
-* `bundle show(1)`:
+* [`bundle show(1)`](bundle-show.1.html):
   Show the source location of a particular gem in the bundle
 
-* [`bundle outdated(1)`][bundle-outdated]:
+* [`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 context of the current bundle
+  Start an IRB session in the current bundle
 
-* `bundle open(1)`:
+* [`bundle open(1)`](bundle-open.1.html):
   Open an installed gem in the editor
 
-* [`bundle lock(1)`][bundle-lock]:
+* [`bundle lock(1)`](bundle-lock.1.hmtl):
   Generate a lockfile for your dependencies
 
-* `bundle viz(1)`:
+* [`bundle viz(1)`](bundle-viz.1.html):
   Generate a visual representation of your dependencies
 
-* `bundle init(1)`:
+* [`bundle init(1)`](bundle-init.1.html):
   Generate a simple `Gemfile`, placed in the current directory
 
-* [`bundle gem(1)`][bundle-gem]:
-  Create a simple gem, suitable for development with bundler
+* [`bundle gem(1)`](bundle-gem.1.html):
+  Create a simple gem, suitable for development with Bundler
 
-* [`bundle platform(1)`][bundle-platform]:
+* [`bundle platform(1)`](bundle-platform.1.html):
   Display platform compatibility information
 
-* `bundle clean(1)`:
-  Clean up unused gems in your bundler directory
+* [`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
 
-* `bundle doctor(1)`:
-  Display warnings about common potential problems
+* [`bundle remove(1)`](bundle-remove.1.html):
+  Removes gems from the Gemfile
 
 ## PLUGINS
 
@@ -99,7 +105,7 @@ and execute it, passing down any extra arguments to it.
 
 ## OBSOLETE
 
-These commands are obsolete and should no longer be used
+These commands are obsolete and should no longer be used:
 
 * `bundle cache(1)`
-* `bundle list(1)`
+* `bundle show(1)`

data/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" "June 2017" "" ""
+.TH "GEMFILE" "5" "November 2018" "" ""
 .
 .SH "NAME"
 \fBGemfile\fR \- A format for describing gem dependencies for Ruby programs
@@ -67,7 +67,7 @@ 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 or Rubinius, 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, Rubinius or TruffleRuby, this should be the Ruby version that the engine is compatible with\.
 .
 .IP "" 4
 .
@@ -82,6 +82,17 @@ ruby "1\.9\.3"
 .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\.
 .
@@ -237,11 +248,11 @@ There are a number of \fBGemfile\fR platforms:
 .
 .TP
 \fBruby\fR
-C Ruby (MRI) or Rubinius, but \fBNOT\fR Windows
+C Ruby (MRI), Rubinius or TruffleRuby, but \fBNOT\fR Windows
 .
 .TP
 \fBmri\fR
-Same as \fIruby\fR, but not Rubinius
+Same as \fIruby\fR, but only C Ruby (MRI)
 .
 .TP
 \fBmingw\fR
@@ -253,18 +264,22 @@ Windows 64 bit \'mingw32\' platform (aka RubyInstaller x64)
 .
 .TP
 \fBrbx\fR
-Same as \fIruby\fR, but only Rubinius (not MRI)
+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, and \fBmswin\fR\.
+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:
@@ -314,7 +329,7 @@ gem "nokogiri",   :platforms => [:mri_18, :jruby]
 .IP "" 0
 .
 .P
-All operations involving groups (\fBbundle install\fR, \fBBundler\.setup\fR, \fBBundler\.require\fR) behave exactly the same as if any groups not matching the current platform were explicitly excluded\.
+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\.
@@ -338,6 +353,9 @@ Bundler will search for child dependencies of this gem by first looking in the s
 .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:
 .
@@ -394,8 +412,20 @@ Git repositories support a number of additional options\.
 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
-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 \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\.
@@ -610,6 +640,9 @@ In the case of the group block form the :optional option can be given to prevent
 .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\.
 .
@@ -626,6 +659,9 @@ end
 .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

data/man/gemfile.5.ronn

@@ -35,7 +35,7 @@ this warning, by using the [`:source` option](#SOURCE) or a
 
 ### CREDENTIALS
 
-Some gem sources require a username and password. Use [bundle config(1)][bundle-config] to set
+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.
@@ -59,8 +59,8 @@ 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 or Rubinius, this should be
-the Ruby version that the engine is compatible with.
+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"
 
@@ -69,6 +69,22 @@ the Ruby version that the engine is compatible with.
 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
@@ -172,22 +188,24 @@ platforms.
 There are a number of `Gemfile` platforms:
 
   * `ruby`:
-    C Ruby (MRI) or Rubinius, but `NOT` Windows
+    C Ruby (MRI), Rubinius or TruffleRuby, but `NOT` Windows
   * `mri`:
-    Same as _ruby_, but not Rubinius
+    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`:
-    Same as _ruby_, but only Rubinius (not MRI)
+    Rubinius
   * `jruby`:
     JRuby
+  * `truffleruby`:
+    TruffleRuby
   * `mswin`:
     Windows
 
 You can restrict further by platform and version for all platforms *except* for
-`rbx`, `jruby`, and `mswin`.
+`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
@@ -212,7 +230,7 @@ As with groups, you can specify one or more platforms:
     gem "ruby-debug", :platforms => :mri_18
     gem "nokogiri",   :platforms => [:mri_18, :jruby]
 
-All operations involving groups (`bundle install`, `Bundler.setup`,
+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.
 
@@ -235,6 +253,12 @@ 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
@@ -287,7 +311,17 @@ 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
 
@@ -427,6 +461,13 @@ 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.
@@ -439,6 +480,11 @@ software is installed or some other conditions are met.
 
 ## 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.