summaryrefslogtreecommitdiff
path: root/man/gemfile.5.txt
diff options
context:
space:
mode:
Diffstat (limited to 'man/gemfile.5.txt')
-rw-r--r--man/gemfile.5.txt190
1 files changed, 95 insertions, 95 deletions
diff --git a/man/gemfile.5.txt b/man/gemfile.5.txt
index f0eaae3b4d..31c12e0772 100644
--- a/man/gemfile.5.txt
+++ b/man/gemfile.5.txt
@@ -99,13 +99,13 @@ 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.
+ 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
+ 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.
@@ -124,7 +124,7 @@ RUBY
GEMS
- Specify gem requirements using the gem method, with the following
+ Specify gem requirements using the gem method, with the following
arguments. All parameters are OPTIONAL unless otherwise specified.
NAME (required)
@@ -147,9 +147,9 @@ GEMS
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
+ 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.
@@ -160,7 +160,7 @@ GEMS
- The argument defaults to the name of the gem. For example, these are
+ The argument defaults to the name of the gem. For example, these are
identical:
@@ -172,8 +172,8 @@ GEMS
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
+ 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.
@@ -183,7 +183,7 @@ GEMS
- The Bundler runtime allows its two main methods, Bundler.setup and
+ The Bundler runtime allows its two main methods, Bundler.setup and
Bundler.require, to limit their impact to particular groups.
@@ -203,10 +203,10 @@ GEMS
- The Bundler CLI allows you to specify a list of groups whose gems
+ The Bundler CLI allows you to specify a list of groups whose gems
bundle install should not install with the without configuration.
- To specify multiple groups to ignore, specify a list of groups
+ To specify multiple groups to ignore, specify a list of groups
separated by spaces.
@@ -216,20 +216,20 @@ GEMS
- Also, calling Bundler.setup with no parameters, or calling require
- "bundler/setup" will setup all groups except for the ones you excluded
+ 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
+ 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 https://bundler.io/rationale.html.
PLATFORMS
- If a gem should only be used in a particular platform or set of
+ 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
+ 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:
@@ -252,11 +252,11 @@ GEMS
mswin Windows
- You can restrict further by platform and version for all platforms
+ 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
+ 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:
@@ -286,12 +286,12 @@ GEMS
- All operations involving groups (bundle install bundle-install.1.html,
- Bundler.setup, Bundler.require) behave exactly the same as if any
+ 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
+ You can select an alternate Rubygems repository for a gem using the
':source' option.
@@ -300,22 +300,22 @@ GEMS
- 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
+ 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
+ it will fall back on global sources using the ordering described in
SOURCE PRIORITY.
- Selecting a specific source repository this way also suppresses the
+ Selecting a specific source repository this way also suppresses the
ambiguous gem warning described above in GLOBAL SOURCES (#source).
- 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
+ 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
@@ -333,27 +333,27 @@ GEMS
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
+ 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
+ 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
+ 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
+ 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
+ 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
+ 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.
@@ -364,34 +364,34 @@ GEMS
- 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
+ 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
+ You MUST only specify at most one of these options. The default
is :branch => "master". For example:
- gem "rails", :git => "https://github.com/rails/rails.git",
+ gem "rails", :git => "https://github.com/rails/rails.git",
:branch => "5-0-stable"
- gem "rails", :git => "https://github.com/rails/rails.git", :tag
+ gem "rails", :git => "https://github.com/rails/rails.git", :tag
=> "v5.0.0"
- gem "rails", :git => "https://github.com/rails/rails.git", :ref
+ gem "rails", :git => "https://github.com/rails/rails.git", :ref
=> "4aded"
submodules
- For reference, a git submodule
+ 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
+ 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
+ If a git repository contains multiple .gemspecs, each .gemspec
+ represents a gem located at the same place in the file system as the
.gemspec.
@@ -406,16 +406,16 @@ GEMS
- To install a gem located in a git repository, bundler changes to the
- directory containing the gemspec, runs gem build name.gemspec and then
+ 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
+ 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
+ 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:
@@ -434,14 +434,14 @@ GEMS
GITHUB
- NOTE: This shorthand should be avoided until Bundler 2.0, since it
- currently expands to an insecure git:// URL. This allows a
+ 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
+ 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.
@@ -464,7 +464,7 @@ GEMS
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
+ public, you can use the :gist shorthand to specify the gist identifier
(without the trailing ".git").
@@ -481,14 +481,14 @@ GEMS
- Since the gist method is a specialization of git_source, it accepts a
+ 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
+ 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.
@@ -506,19 +506,19 @@ GEMS
- Since the bitbucket method is a specialization of git_source, it
+ 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
+ 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,
+ 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
+ Unlike :git, bundler does not compile C extensions for gems specified
as paths.
@@ -527,9 +527,9 @@ GEMS
- If you would like to use multiple local gems directly from the
+ 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
+ gem's files. This will automatically load gemspec files from
subdirectories.
@@ -569,24 +569,24 @@ BLOCK FORM OF SOURCE, GIT, PATH, GROUP and PLATFORMS
- 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
+ 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
+ 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
+ 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
+ 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.