From 72dea3d930fbb8d02327af949990793b9cb76185 Mon Sep 17 00:00:00 2001 From: Evax Software Date: Wed, 18 Jan 2012 14:28:10 +0100 Subject: [PATCH] __rvm* types documentation cleanup --- conf/type/__rvm_gem/man.text | 4 ++++ conf/type/__rvm_gemset/man.text | 9 ++++----- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/conf/type/__rvm_gem/man.text b/conf/type/__rvm_gem/man.text index 951884b8..27b16053 100644 --- a/conf/type/__rvm_gem/man.text +++ b/conf/type/__rvm_gem/man.text @@ -34,6 +34,10 @@ EXAMPLES # Install the rails gem in gemset ruby-1.9.3-p0@myset for user bill __rvm_gemset rails --gemset ruby-1.9.3-p0@myset --user bill --state installed +# Do the same and also make ruby-1.9.3-p0@myset the default gemset +__rvm_gemset rails --gemset ruby-1.9.3-p0@myset --user bill \ + --state installed --default yes + # Remove it __rvm_ruby rails --gemset ruby-1.9.3-p0@myset --user bill --state removed -------------------------------------------------------------------------------- diff --git a/conf/type/__rvm_gemset/man.text b/conf/type/__rvm_gemset/man.text index d7b4c04c..f1e3f2bf 100644 --- a/conf/type/__rvm_gemset/man.text +++ b/conf/type/__rvm_gemset/man.text @@ -17,17 +17,13 @@ REQUIRED PARAMETERS ------------------- user:: The remote user account to use -ruby:: - The ruby version to use -name:: - The gemset name (including state:: Either "installed" or "removed". OPTIONAL PARAMETERS ------------------- default:: - If set to anything but "no" (the default), set the give gemset as default. + If set to anything but "no" (the default), set the given gemset as default. EXAMPLES -------- @@ -36,6 +32,9 @@ EXAMPLES # Install the gemset @myset for user charles on based on ruby-1.9.3-0 __rvm_gemset ruby-1.9.3-p0@myset --user charles --state installed +# Do the same and make ruby-1.9.3-p0@myset the default gemset +__rvm_gemset ruby-1.9.3-p0@myset --user charles --state installed --default yes + # Remove the gemset @myset for user john __rvm_ruby ruby-1.9.3-p0@myset --user john --state removed --------------------------------------------------------------------------------