summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorchrismo <chrismo@clabs.org>2016-10-24 18:01:00 -0500
committerchrismo <chrismo@clabs.org>2016-10-24 20:23:23 -0500
commit5b303e7d1a361369a8170172b1b95e2382dc9a55 (patch)
tree5141353170105b1b012afbadef674cc27a2bef56
parent2e61117454ff3ef7f614ad003a87fcbafa975978 (diff)
downloadbundler-5b303e7d1a361369a8170172b1b95e2382dc9a55.tar.gz
Update bundle lock man page
-rw-r--r--lib/bundler/cli.rb6
-rw-r--r--man/bundle-lock.ronn36
-rw-r--r--man/bundle-update.ronn9
3 files changed, 43 insertions, 8 deletions
diff --git a/lib/bundler/cli.rb b/lib/bundler/cli.rb
index 8e8f13701b..9021edf6ab 100644
--- a/lib/bundler/cli.rb
+++ b/lib/bundler/cli.rb
@@ -466,9 +466,9 @@ module Bundler
method_option "full-index", :type => :boolean, :default => false, :banner =>
"Fall back to using the single-file index of all gems"
method_option "add-platform", :type => :array, :default => [], :banner =>
- "add a new platform to the lockfile"
+ "Add a new platform to the lockfile"
method_option "remove-platform", :type => :array, :default => [], :banner =>
- "remove a platform from the lockfile"
+ "Remove a platform from the lockfile"
method_option "patch", :type => :boolean, :banner =>
"If updating, prefer updating only to next patch version"
method_option "minor", :type => :boolean, :banner =>
@@ -478,7 +478,7 @@ module Bundler
method_option "strict", :type => :boolean, :banner =>
"If updating, do not allow any gem to be updated past latest --patch | --minor | --major"
method_option "conservative", :type => :boolean, :banner =>
- "If updating, use bundle install conservative update behavior and do not allow shared dependencies to be updated."
+ "If updating, use bundle install conservative update behavior and do not allow shared dependencies to be updated"
def lock
require "bundler/cli/lock"
Lock.new(options).run
diff --git a/man/bundle-lock.ronn b/man/bundle-lock.ronn
index 8afc50af8a..b18d819c21 100644
--- a/man/bundle-lock.ronn
+++ b/man/bundle-lock.ronn
@@ -7,6 +7,14 @@ bundle-lock(1) -- Creates / Updates a lockfile without installing
[--local]
[--print]
[--lockfile=PATH]
+ [--full-index]
+ [--add-platform]
+ [--remove-platform]
+ [--patch]
+ [--minor]
+ [--major]
+ [--strict]
+ [--conservative]
## DESCRIPTION
@@ -30,6 +38,30 @@ Lock the gems specified in Gemfile.
* `--lockfile=<path>`:
The path where the lockfile should be written to.
+* `--full-index`:
+ Fall back to using the single-file index of all gems.
+
+* `--add-platform`:
+ Add a new platform to the lockfile.
+
+* `--remove-platform`:
+ Remove a platform from the lockfile.
+
+* `--patch`:
+ If updating, prefer updating only to next patch version.
+
+* `--minor`:
+ If updating, prefer updating only to next minor version.
+
+* `--major`:
+ If updating, prefer updating to next major version (default).
+
+* `--strict`:
+ If updating, do not allow any gem to be updated past latest --patch | --minor | --major.
+
+* `--conservative`:
+ If updating, use bundle install conservative update behavior and do not allow shared dependencies to be updated.
+
## UPDATING ALL GEMS
If you run `bundle lock` with `--update` option without list of gems, bundler will
@@ -45,3 +77,7 @@ For instance, you only want to update `nokogiri`, run `bundle lock --update noko
Bundler will update `nokogiri` and any of its dependencies, but leave the rest of the
gems that you specified locked to the versions in the `Gemfile.lock`.
+
+## PATCH LEVEL OPTIONS
+
+See [bundle update(1)][bundle-update] for details.
diff --git a/man/bundle-update.ronn b/man/bundle-update.ronn
index 1083c9db41..7986a17bdc 100644
--- a/man/bundle-update.ronn
+++ b/man/bundle-update.ronn
@@ -75,7 +75,6 @@ gem.
* `--conservative`:
Use bundle install conservative update behavior and do not allow shared dependencies to be updated.
-
## UPDATING ALL GEMS
If you run `bundle update` with no parameters, bundler will ignore
@@ -265,17 +264,17 @@ Given the following gem specifications:
foo 1.5.0, requires: ~> bar 2.1
foo 1.5.1, requires: ~> bar 3.0
bar with versions 2.0.3, 2.0.4, 2.1.0, 2.1.1, 3.0.0
-
+
Gemfile:
gem 'foo'
-
+
Gemfile.lock:
foo (1.4.3)
bar (~> 2.0)
bar (2.0.3)
-
+
Cases:
# Command Line Result
@@ -285,7 +284,7 @@ Cases:
3 bundle update --minor 'foo 1.5.1', 'bar 3.0.0'
4 bundle update --minor --strict 'foo 1.5.0', 'bar 2.1.1'
5 bundle update --patch --strict 'foo 1.4.4', 'bar 2.0.4'
-
+
In case 1, bar is upgraded to 2.1.1, a minor version increase, because
the dependency from foo 1.4.5 required it.