summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorPatricia Arbona <arbonap@gmail.com>2017-07-22 16:53:23 -0500
committerPatricia Arbona <arbonap@gmail.com>2017-07-23 15:18:33 -0500
commitef83bc3d3e597e3ad7687a1aa186412d7e156e80 (patch)
tree829459e30da974ae015bfd2b9ea890d30ab2082b /man
parenta0b16613040382b5db2c3c14b4fdf04f9091e641 (diff)
downloadbundler-ef83bc3d3e597e3ad7687a1aa186412d7e156e80.tar.gz
Add bundle-install and gemfile background explanations
Diffstat (limited to 'man')
-rw-r--r--man/gemfile.5.ronn31
1 files changed, 31 insertions, 0 deletions
diff --git a/man/gemfile.5.ronn b/man/gemfile.5.ronn
index dead032ced..9baa7f8e3e 100644
--- a/man/gemfile.5.ronn
+++ b/man/gemfile.5.ronn
@@ -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
@@ -287,7 +303,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
@@ -439,6 +465,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.