summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJosé Valim <jose.valim@plataformatec.com.br>2012-05-18 11:01:26 +0200
committerJosé Valim <jose.valim@plataformatec.com.br>2012-05-18 11:01:35 +0200
commita2671929b8c9175df48c905052b8fc4b7572f899 (patch)
tree23127b17cdf9873a134bc334994f0cb260d84232
parentca60146c179ee491bd0a03ef6b1f97bb74cb6427 (diff)
downloadbundler-a2671929b8c9175df48c905052b8fc4b7572f899.tar.gz
Make explicit what is expected in the local.GEM_NAME syntax
-rw-r--r--man/bundle-config.ronn10
1 files changed, 7 insertions, 3 deletions
diff --git a/man/bundle-config.ronn b/man/bundle-config.ronn
index dc07b69c17..46c9ac6ea7 100644
--- a/man/bundle-config.ronn
+++ b/man/bundle-config.ronn
@@ -102,15 +102,19 @@ Bundler also allows you to work against a git repository locally
instead of using the remote version. This can be achieved by setting
up a local override:
- bundle config local.rack ~/path/to/local/rack
+ bundle config local.GEM_NAME /path/to/local/git/repository
-Now, instead of checking out the remote git repository, the local
+For example, in order to use a local Rack repository, a developer could call:
+
+ bundle config local.rack ~/Work/git/rack
+
+Now instead of checking out the remote git repository, the local
override will be used. Similar to a path source, every time the local
git repository change, changes will be automatically picked up by
Bundler. This means a commit in the local git repo will update the
revision in the `Gemfile.lock` to the local git repo revision. This
requires the same attention as git submodules. Before pushing to
-remote, you need to ensure the local override was pushed, otherwise
+the remote, you need to ensure the local override was pushed, otherwise
you may point to a commit that only exists in your local machine.
Bundler does many checks to ensure a developer won't work with