summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorForest Gagnon <forestgagnon@gmail.com>2018-06-27 00:14:00 -0700
committerforestgagnon <forestgagnon@gmail.com>2018-06-29 11:17:33 -0700
commitee3f3a6a6ee639a2504122a20349b34ce562e3e6 (patch)
tree3e9a16004ca5b62901b373cbbe1898808e07823a
parentb8fdc4ae2318369a7cd71eabcdc611162fa2fee6 (diff)
downloadbundler-ee3f3a6a6ee639a2504122a20349b34ce562e3e6.tar.gz
add warning to docs for explicit source gotcha
This commit adds a warning to the Gemfile documentation to more clearly indicate that specifying an explicit source on a per-gem or block basis also makes that scoped source a global source. Also adds a recommendation that users ensure that all gems in the Gemfile are using explicit sources whenever they introduce any explicit source blocks or source directives on individual gems.
-rw-r--r--man/gemfile.5.ronn13
1 files changed, 13 insertions, 0 deletions
diff --git a/man/gemfile.5.ronn b/man/gemfile.5.ronn
index 5c7ba23b29..4354bcd622 100644
--- a/man/gemfile.5.ronn
+++ b/man/gemfile.5.ronn
@@ -251,6 +251,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
@@ -453,6 +459,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.