diff options
| author | The Bundler Bot <bot@bundler.io> | 2017-10-01 06:52:12 +0000 |
|---|---|---|
| committer | The Bundler Bot <bot@bundler.io> | 2017-10-01 06:52:12 +0000 |
| commit | 0747989a9bf47fc0404248d20628ab64ce09d3be (patch) | |
| tree | 8be5291594f491db763068299da9f43c83427448 /man/bundle-install.ronn | |
| parent | c855c8a7640dcee9fb258fcc4e14cbf5774d62b7 (diff) | |
| parent | 2341b13b0d87047df041ad6450d95d50bc4ad55d (diff) | |
| download | bundler-0747989a9bf47fc0404248d20628ab64ce09d3be.tar.gz | |
Auto merge of #5889 - bundler:rubymorillo-patch-4, r=colby-swandale
Added a sentence to `binstubs`
Per feedback from @arbonap, we've added a sentence that briefly explains what binstubs is to the binstubs section.
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...no understanding of what binstubs is. Added a quick two sentences!
### What was your diagnosis of the problem?
My diagnosis was...we needed some language there. @arbonap and @indirect pointed this out and offered the explanations.
### What is your fix for the problem, implemented in this PR?
My fix...was to turn their explanations into simple language!
### Why did you choose this fix out of the possible options?
I chose this fix because...it'll help users understand binstubs better
Diffstat (limited to 'man/bundle-install.ronn')
| -rw-r--r-- | man/bundle-install.ronn | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/man/bundle-install.ronn b/man/bundle-install.ronn index de081b4139..c7e38e154f 100644 --- a/man/bundle-install.ronn +++ b/man/bundle-install.ronn @@ -47,7 +47,12 @@ To apply any of `--binstubs`, `--deployment`, `--path`, 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 |