summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThe Bundler Bot <bot@bundler.io>2017-07-22 09:26:28 +0000
committerThe Bundler Bot <bot@bundler.io>2017-07-22 09:26:28 +0000
commit39f3603a02ce688d92266de75292cc21960f0ba8 (patch)
tree07cfe2ccead281db73c5364656724377b5ab9039
parent1925caf83c9dd67a387d4bd75f9350baecdbd5f8 (diff)
parentb649ff80914068f2c2b35288d64f3e06c200b0d0 (diff)
downloadbundler-39f3603a02ce688d92266de75292cc21960f0ba8.tar.gz
Auto merge of #5882 - bundler:rubymorillo-patch-1, r=colby-swandale
Add graph re: bundle exec modifying lockfile Hey team, I've added a graph to the documentation that explains why bundle exec makes changes to Gemfile.lock. It was originally referenced in this issue: https://github.com/bundler/bundler/issues/5245 Thanks so much for the contribution! To make reviewing this PR a bit easier, please fill out answers to the following questions. ### What was the end-user problem that led to this PR? The problem was lack of clarity around why the `bundle exec` command modified the lock file. A user brought it up here: https://github.com/bundler/bundler/issues/5245 and the determination was to add it to the man page. ### What was your diagnosis of the problem? My diagnosis was to add a graph in the "Environmental Modifications" section to explain the issue. ### What is your fix for the problem, implemented in this PR? My fix was to update the docs! \o/ ### Why did you choose this fix out of the possible options? I chose this fix because enough users referenced it as a problem that needed to be addressed.
-rw-r--r--man/bundle-exec.ronn7
1 files changed, 7 insertions, 0 deletions
diff --git a/man/bundle-exec.ronn b/man/bundle-exec.ronn
index c9ab2309e4..bd6e36d981 100644
--- a/man/bundle-exec.ronn
+++ b/man/bundle-exec.ronn
@@ -63,6 +63,13 @@ It also modifies Rubygems:
making system executables work
* Add all gems in the bundle into Gem.loaded_specs
+Finally, `bundle exec` also implicitly modifies `Gemfile.lock` if the lockfile
+and the Gemfile do not match. Bundler needs the Gemfile to determine things
+such as a gem's groups, `autorequire`, and platforms, etc., and that
+information isn't stored in the lockfile. The Gemfile and lockfile must be
+synced in order to `bundle exec` successfully, so `bundle exec`
+updates the lockfile beforehand.
+
### Loading
By default, when attempting to `bundle exec` to a file with a ruby shebang,