diff options
| author | Charles Strahan <charles.c.strahan@gmail.com> | 2014-10-31 02:03:37 +0000 |
|---|---|---|
| committer | Charles Strahan <charles.c.strahan@gmail.com> | 2014-10-31 02:03:37 +0000 |
| commit | 143698555a7927c926d5fa4180c4349bf371798b (patch) | |
| tree | 412164ef9d9933398d42ad27a5f150f2aa650c6d /pkgs/development/interpreters/ruby/load-ruby-env.nix | |
| parent | 3eeabc452353bdcd13d27ede98ff3612fa38924b (diff) | |
| download | nixlib-143698555a7927c926d5fa4180c4349bf371798b.tar nixlib-143698555a7927c926d5fa4180c4349bf371798b.tar.gz nixlib-143698555a7927c926d5fa4180c4349bf371798b.tar.bz2 nixlib-143698555a7927c926d5fa4180c4349bf371798b.tar.lz nixlib-143698555a7927c926d5fa4180c4349bf371798b.tar.xz nixlib-143698555a7927c926d5fa4180c4349bf371798b.tar.zst nixlib-143698555a7927c926d5fa4180c4349bf371798b.zip | |
add documentation
Diffstat (limited to 'pkgs/development/interpreters/ruby/load-ruby-env.nix')
| -rw-r--r-- | pkgs/development/interpreters/ruby/load-ruby-env.nix | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/pkgs/development/interpreters/ruby/load-ruby-env.nix b/pkgs/development/interpreters/ruby/load-ruby-env.nix index f1c9f71f51ce..1a28e1cd0474 100644 --- a/pkgs/development/interpreters/ruby/load-ruby-env.nix +++ b/pkgs/development/interpreters/ruby/load-ruby-env.nix @@ -1,5 +1,31 @@ { ruby, lib, callPackage, gemFixes, fetchurl, buildRubyGem }@defs: +# This function builds a set of gems. You first convert your Gemfile to an attrset +# called a "gemset", and then use this function to build the gemset. +# +# A gemset looks like the following: +# +# { +# libv8 = { +# version = "3.16.14.7"; +# src = { +# type = "gem"; +# sha256 = "..."; +# }; +# }; +# therubyracer = { +# version = "0.12.1"; +# dependencies = [ "libv8" ]; +# src = { +# type = "gem"; +# sha256 = "..."; +# }; +# }; +# } +# +# If you use these gems as build inputs, the GEM_PATH will be updated +# appropriately, and command like `bundle exec` should work out of the box. + { gemset, ruby ? defs.ruby, fixes ? gemFixes }@args: let |