Permalink
Browse files

Add documentation for the benchmark CLI utility

  • Loading branch information...
1 parent 6621a66 commit e547c863ca4fa49832702df6d8c6f52cd4af5ea0 @pascalh1011 committed May 11, 2011
Showing with 25 additions and 1 deletion.
  1. +1 −1 lib/bundler/cli.rb
  2. +20 −0 man/bundle-benchmark.ronn
  3. +3 −0 man/bundle.ronn
  4. +1 −0 man/index.txt
View
@@ -440,7 +440,7 @@ def console(group = nil)
IRB.start
end
- desc "benchmark [GROUP]", "Displays the time taken for each each gem to be loaded into the environment"
+ desc "benchmark [GROUP]", "Displays the time taken for each gem to be loaded into the environment"
def benchmark(group = nil)
Bundler.ui.debug!
Bundler.ui.debug "Gem require times as included by bundle:"
View
@@ -0,0 +1,20 @@
+bundle-benchmark(1) -- Display the time taken for each gem to be loaded
+=======================================================================
+
+## SYNOPSIS
+
+`bundle benchmark` [group]
+
+## DESCRIPTION
+
+This command loads all your required dependencies as per Bundler.setup, and
+displays the total time spent in requiring each gem and its dependencies.
+
+Use this command to track down problems with excessive boot time in your
+application, or to optimize specific groups in your Gemfile for fast setup.
+
+## GROUP OPTION
+
+To test the load times for gems in a specific group, pass the group as an
+argument to `bundle benchmark`. Omitting this option loads all dependencies
+in your Gemfile.
View
@@ -66,6 +66,9 @@ We divide `bundle` subcommands into primary commands and utilities.
* `bundle viz(1)`:
Generate a visual representation of your dependencies
+
+* `bundle benchmark(1)`:
+ Display the time taken for each each gem to be loaded into the environment
* `bundle init(1)`:
Generate a simple `Gemfile`, placed in the current directory
View
@@ -4,3 +4,4 @@ bundle-update bundle-update.1
bundle-package bundle-package.1
bundle-exec bundle-exec.1
bundle-config bundle-config.1
+bundle-benchmark bundle-benchmark.1

0 comments on commit e547c86

Please sign in to comment.