summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Lance <stefan@lances.net>2015-06-21 22:00:12 -0500
committerSamuel E. Giddins <segiddins@segiddins.me>2015-07-16 16:51:11 -0700
commit399310d3ad3a1cbeb144a480587b372f55f81805 (patch)
tree2531d4bde13c58b194f34bb9bb4b042c5760dde7
parent21ccce158a89ad55320b04810e6e0ca1d30a3c13 (diff)
downloadbundler-399310d3ad3a1cbeb144a480587b372f55f81805.tar.gz
Edit manpages
-rw-r--r--UPGRADING.md4
-rw-r--r--lib/bundler/cli.rb4
-rw-r--r--man/bundle-exec.ronn10
3 files changed, 10 insertions, 8 deletions
diff --git a/UPGRADING.md b/UPGRADING.md
index 0162742988..3b1830f8d1 100644
--- a/UPGRADING.md
+++ b/UPGRADING.md
@@ -20,4 +20,6 @@ The `bundler/capistrano` and `bundler/vlad` deployment helper files have been re
#### Removed: `bundle install --binstubs`
-The `--binstubs` option has been removed from `bundle install` and replaced with the `bundle binstubs` command. \ No newline at end of file
+The `--binstubs` option has been removed from `bundle install` and replaced with the `bundle binstubs` command. This means that binstubs must be created and checked into version control individually.
+
+The `bundle binstubs [GEM]` command accepts two optional arguments: `--force`, which overwrites existing binstubs if they exist, and `--path=PATH`, which specifies the directory in which the binstubs will be installed (./bin by default). \ No newline at end of file
diff --git a/lib/bundler/cli.rb b/lib/bundler/cli.rb
index 6a1172efcd..374760e65f 100644
--- a/lib/bundler/cli.rb
+++ b/lib/bundler/cli.rb
@@ -202,8 +202,8 @@ module Bundler
desc "binstubs GEM [OPTIONS]", "Install the binstubs of the listed gem"
long_desc <<-D
- Generate binstubs for executables in [GEM]. Binstubs are put into bin,
- or the --binstubs directory if one has been set.
+ Generate binstubs for executables in [GEM]. Binstubs are put into bin
+ by default.
D
method_option "force", :type => :boolean, :default => false, :banner =>
"Overwrite existing binstubs if they exist"
diff --git a/man/bundle-exec.ronn b/man/bundle-exec.ronn
index ba6844c5c2..9c8f8f2199 100644
--- a/man/bundle-exec.ronn
+++ b/man/bundle-exec.ronn
@@ -25,13 +25,13 @@ available on your shell's `$PATH`.
flag is passed, exec will revert to the 1.9 behaviour of passing all file
descriptors to the new process.
-## BUNDLE INSTALL --BINSTUBS
+## BUNDLE BINSTUBS
-If you use the `--binstubs` flag in [bundle install(1)][bundle-install], Bundler will
-automatically create a directory (which defaults to `app_root/bin`)
-containing all of the executables available from gems in the bundle.
+If you use the `bundle binstubs [GEM]` command, Bundler will create a
+directory (which defaults to `app_root/bin`) in which the GEM executable from
+from the bundle will be installed.
-After using `--binstubs`, `bin/rspec spec/my_spec.rb` is identical
+After using `bundle binstubs`, `bin/rspec spec/my_spec.rb` is identical
to `bundle exec rspec spec/my_spec.rb`.
## ENVIRONMENT MODIFICATIONS