summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoe Rafaniello <jrafanie@redhat.com>2015-05-29 12:31:37 -0400
committerJoe Rafaniello <jrafanie@redhat.com>2015-06-22 11:50:03 -0400
commit9b502a2464a3f38959484d6d1de26488a3da7d63 (patch)
treefba1052d5697fedf3635771291be6fcc424e6a42
parente8c962ef2a3215cdc6fd411b6724f091a16793d6 (diff)
downloadbundler-9b502a2464a3f38959484d6d1de26488a3da7d63.tar.gz
Clarify BUNDLE_PATH documentation.
* BUNDLE_PATH is used for installing AND finding gems * When set * GEM_HOME and GEM_PATH are ignored * All gems are installed and retrieved from the BUNDLE_PATH location [skip ci]
-rw-r--r--man/bundle-config.ronn6
1 files changed, 4 insertions, 2 deletions
diff --git a/man/bundle-config.ronn b/man/bundle-config.ronn
index 1a9230853e..21e319fefc 100644
--- a/man/bundle-config.ronn
+++ b/man/bundle-config.ronn
@@ -84,8 +84,10 @@ The following is a list of all configuration keys and their purpose. You can
learn more about their operation in [bundle install(1)][bundle-install].
* `path` (`BUNDLE_PATH`):
- The location on disk to install gems. Defaults to `$GEM_HOME` in development
- and `vendor/bundle` when `--deployment` is used
+ The location on disk where all gems in your bundle will be located regardless
+ of `$GEM_HOME` or `$GEM_PATH` values. Bundle gems not found in this location
+ will be installed by bundle install. Defaults to `Gem.dir`. When --deployment is
+ used, defaults to vendor/bundle.
* `frozen` (`BUNDLE_FROZEN`):
Disallow changes to the `Gemfile`. Defaults to `true` when `--deployment`
is used.