aboutsummaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorSamuel Giddins <segiddins@segiddins.me>2016-12-26 16:10:49 -0600
committerSamuel Giddins <segiddins@segiddins.me>2016-12-26 16:10:49 -0600
commitec102ebd3dd61c66a3ed25d90c06a001cde03a5c (patch)
tree5b49c624a404aaf928089249229727d3bf0dbb0d /man
parent6f50e4346383969655027f3a57f5e46c387fa2c8 (diff)
downloadbundler-ec102ebd3dd61c66a3ed25d90c06a001cde03a5c.tar.gz
[Docs] Add docs for trampolining
🎉
Diffstat (limited to 'man')
-rw-r--r--man/bundle.ronn18
1 files changed, 18 insertions, 0 deletions
diff --git a/man/bundle.ronn b/man/bundle.ronn
index f2b1daa0..065cfd44 100644
--- a/man/bundle.ronn
+++ b/man/bundle.ronn
@@ -91,6 +91,24 @@ When running a command that isn't listed in PRIMARY COMMANDS or UTILITIES,
Bundler will try to find an executable on your path named `bundler-<command>`
and execute it, passing down any extra arguments to it.
+## BUNDLER TRAMPOLINING
+
+Bundler includes a feature called trampolining, designed to allow a single
+developer to work on multiple projects, each on different Bundler versions.
+The trampoline will infer the correct version of Bundler to use for each project
+and load that version instead of the version directly invoked (which is almost
+always the newest version installed locally).
+
+Bundler by default will use the Bundler version in the current directory to
+determine the version to trampoline to, reading from the `BUNDLED WITH` section.
+However, if the `BUNDLER_VERSION` environment variable is set, that version will
+override the lockfile inference and can be used in directories without a
+lockfile.
+
+Until the target version is Bundler 2 or later, `BUNDLE_ENABLE_TRAMPOLINE` must
+be set for the trampoline to be used. Additionally, `BUNDLE_DISABLE_POSTIT` can
+be set to completely disable the trampoline.
+
## OBSOLETE
These commands are obsolete and should no longer be used