summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStephanie Morillo <rubymorillo@users.noreply.github.com>2017-07-20 14:55:10 -0400
committerGitHub <noreply@github.com>2017-07-20 14:55:10 -0400
commit5396c23308a42216d60ab0156846a17fe8061bb3 (patch)
tree5e62d390f715ec1c35110827282667303ffc919e
parent53dfec6917c9fd2795856cbd776cff2029a0416e (diff)
downloadbundler-5396c23308a42216d60ab0156846a17fe8061bb3.tar.gz
Added a sentence to `binstubs`
Per feedback from @arbonap, we've added a sentence that briefly explains what binstubs is to the binstubs section.
-rw-r--r--man/bundle-install.ronn7
1 files changed, 6 insertions, 1 deletions
diff --git a/man/bundle-install.ronn b/man/bundle-install.ronn
index d4bc34909a..0abfa97a4c 100644
--- a/man/bundle-install.ronn
+++ b/man/bundle-install.ronn
@@ -47,7 +47,12 @@ To apply any of `--deployment`, `--path`, `--binstubs`, or `--without` every
time `bundle install` is run, use `bundle config` (see bundle-config(1)).
* `--binstubs[=<directory>]`:
- Creates a directory (defaults to `~/bin`) and place any executables from the
+ Binstubs are scripts that wrap around executables. Bundler creates a small Ruby
+ file (a binstub) that loads Bundler, runs the command, and puts it in `bin/`.
+ This lets you link the binstub inside of an application to the exact gem
+ version the application needs.
+
+ Creates a directory (defaults to `~/bin`) and places any executables from the
gem there. These executables run in Bundler's context. If used, you might add
this directory to your environment's `PATH` variable. For instance, if the
`rails` gem comes with a `rails` executable, this flag will create a