summaryrefslogtreecommitdiff
path: root/man/gemfile.5.ronn
diff options
context:
space:
mode:
authorSteven Hancock <stevenh512@gmail.com>2012-05-21 00:18:57 -0700
committerSteven Hancock <stevenh512@gmail.com>2012-05-21 00:18:57 -0700
commit9cf8f24e45f9b6306aa86fda291308c2c5fa1a70 (patch)
tree3e45cdf7f98b7ef0cd296fe0cd769268e6996d65 /man/gemfile.5.ronn
parenta2671929b8c9175df48c905052b8fc4b7572f899 (diff)
downloadbundler-9cf8f24e45f9b6306aa86fda291308c2c5fa1a70.tar.gz
Documentation for Ruby Versions
Update the `gemfile` man page to include documentation for specifying Ruby versions.
Diffstat (limited to 'man/gemfile.5.ronn')
-rw-r--r--man/gemfile.5.ronn27
1 files changed, 27 insertions, 0 deletions
diff --git a/man/gemfile.5.ronn b/man/gemfile.5.ronn
index bc10f16a44..53e6140247 100644
--- a/man/gemfile.5.ronn
+++ b/man/gemfile.5.ronn
@@ -25,6 +25,33 @@ might contain the gems listed in the `Gemfile`.
Each of these _source_s `MUST` be a valid Rubygems repository.
+## RUBY (#ruby)
+
+If your application requires a specific Ruby version or engine, specify your
+requirements using the `ruby` method, with the following arguments.
+All parameters are `OPTIONAL` unless otherwise specified.
+
+### VERSION (required)
+
+The version of Ruby that your application requires. If your application
+requires an alternate Ruby engine, such as JRuby or Rubinius, this should be
+the Ruby version that the engine is compatible with.
+
+ ruby "1.9.3"
+
+### ENGINE (:engine)
+
+Each application _may_ specify a Ruby engine. If an engine is specified, an
+engine version _must_ also be specified.
+
+### ENGINE VERSION (:engine_version)
+
+Each application _may_ specify a Ruby engine version. If an engine version is
+specified, an engine _must_ also be specified. If the engine is "ruby" the
+engine version specified _must_ match the Ruby version.
+
+ ruby "1.8.7", :engine => "jruby", :engine_version => "1.6.7"
+
## GEMS (#gem)
Specify gem requirements using the `gem` method, with the following arguments.