diff options
author | John Firebaugh <john.firebaugh@gmail.com> | 2010-10-02 10:15:33 -0700 |
---|---|---|
committer | Andre Arko <andre@arko.net> | 2010-10-10 14:14:44 -0700 |
commit | 84dd4d401a9bb9ca5fa46ac8411e2011c497d833 (patch) | |
tree | ee443210aea9e5988dd586aa41a0edfc4e190464 /man | |
parent | 84931413ac2c7e20f5b2daf401391ef737b10917 (diff) | |
download | bundler-84dd4d401a9bb9ca5fa46ac8411e2011c497d833.tar.gz |
Document the #gemspec method.
Diffstat (limited to 'man')
-rw-r--r-- | man/gemfile.5.ronn | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/man/gemfile.5.ronn b/man/gemfile.5.ronn index 33d0aaed3f..7553fc7815 100644 --- a/man/gemfile.5.ronn +++ b/man/gemfile.5.ronn @@ -240,6 +240,25 @@ In the case of the `git` block form, the `:ref`, `:branch`, `:tag`, and `:submodules` options may be passed to the `git` method, and all gems in the block will inherit those options. +## GEMSPEC (#gemspec) + +If you wish to use Bundler to help install dependencies for a gem while it is +being developed, use the `gemspec` method to pull in the dependencies listed in +the `.gemspec` file. + +The `gemspec` method adds any runtime dependencies as gem requirements in the +default group. It also adds development dependencies as gem requirements in the +`development` group. Finally, it adds a gem requirement on your project (`:path +=> '.'`). In conjunction with `Bundler.setup`, this allows you to require project +files in your test code as you would if the project were installed as a gem; you +need not manipulate the load path manually or require project files via relative +paths. + +The `gemspec` method supports optional `:path`, `:name`, and `:development_group` +options, which control where bundler looks for the `.gemspec`, what named +`.gemspec` it uses (if more than one is present), and which group development +dependencies are included in. + ## SOURCE PRIORITY When attempting to locate a gem to satisfy a gem requirement, |