summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThe Bundler Bot <bot@bundler.io>2017-08-31 18:26:11 +0000
committerThe Bundler Bot <bot@bundler.io>2017-08-31 18:26:11 +0000
commit57f5ef656bb1845079225dde42b2d91ecb07ee2b (patch)
treedac0c129402508acdda2bd3e28c7322019e2466e
parent570012724216e8a4f8cd2ffe9eb8acdfc94be133 (diff)
parent7b61ebd45b15ee71f4000b3bae97e56f4540ea71 (diff)
downloadbundler-57f5ef656bb1845079225dde42b2d91ecb07ee2b.tar.gz
Auto merge of #5983 - asehra:master, r=segiddins
Add documentation for packaging with --no-install ### What was the end-user problem that led to this PR? I need to package gems for deployment but don't want to install them on the local system. ### What was your diagnosis of the problem? The behaviour is a part of bundler but it is not documented anywhere in man pages or the bundler site. To find the answer, one has to look at issues that were closed a few years ago. ### What is your fix for the problem, implemented in this PR? I've updated the man page for the `bundle package` command. Hopefully, this will trickle down to bundler site pages for package command whenever CI publishes it. Followed the doc [here](https://github.com/bundler/bundler/blob/master/doc/documentation/WRITING.md) to run tests. ### Why did you choose this fix out of the possible options? It felt appropriate to document a flag available on a CLI in its help pages.
-rw-r--r--man/bundle-package.ronn5
1 files changed, 5 insertions, 0 deletions
diff --git a/man/bundle-package.ronn b/man/bundle-package.ronn
index 512b037f51..78bbd88c4b 100644
--- a/man/bundle-package.ronn
+++ b/man/bundle-package.ronn
@@ -65,3 +65,8 @@ machine and check in the gems. For instance, you can run
`bundle package` on an identical staging box during your
staging process, and check in the `vendor/cache` before
deploying to production.
+
+By default, [bundle package(1)][bundle-package] fetches and also
+installs the gems to the default location. To package the
+dependencies to `vendor/cache` without installing them to the
+local install location, you can run `bundle package --no-install`.