__rvm* types documentation cleanup

This commit is contained in:
Evax Software 2012-01-18 14:28:10 +01:00
parent 8cc0d6f0e7
commit 72dea3d930
2 changed files with 8 additions and 5 deletions

View file

@ -34,6 +34,10 @@ EXAMPLES
# Install the rails gem in gemset ruby-1.9.3-p0@myset for user bill # 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 __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 # Remove it
__rvm_ruby rails --gemset ruby-1.9.3-p0@myset --user bill --state removed __rvm_ruby rails --gemset ruby-1.9.3-p0@myset --user bill --state removed
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------

View file

@ -17,17 +17,13 @@ REQUIRED PARAMETERS
------------------- -------------------
user:: user::
The remote user account to use The remote user account to use
ruby::
The ruby version to use
name::
The gemset name (including
state:: state::
Either "installed" or "removed". Either "installed" or "removed".
OPTIONAL PARAMETERS OPTIONAL PARAMETERS
------------------- -------------------
default:: 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 EXAMPLES
-------- --------
@ -36,6 +32,9 @@ EXAMPLES
# Install the gemset @myset for user charles on based on ruby-1.9.3-0 # 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 __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 # Remove the gemset @myset for user john
__rvm_ruby ruby-1.9.3-p0@myset --user john --state removed __rvm_ruby ruby-1.9.3-p0@myset --user john --state removed
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------