Permalink
Browse files

Corrected GSP (Grammar, Spelling, Punctuation) errors.

  • Loading branch information...
1 parent 83a5d3a commit 0f65fda936fe2c0f7aba565e32c8dd9f6a7c177b @ParkinT ParkinT committed Apr 30, 2012
Showing with 50 additions and 44 deletions.
  1. +1 −1 help/benchmark
  2. +0 −1 help/cleanup
  3. +3 −3 help/color
  4. +1 −1 help/disk-usage
  5. +3 −3 help/do
  6. +3 −3 help/gemset
  7. +1 −1 help/info
  8. +1 −1 help/migrate
  9. +4 −0 help/monitor
  10. +2 −2 help/rake
  11. +4 −4 help/repair
  12. +4 −3 help/rubygems
  13. +4 −4 help/rvmrc
  14. +4 −3 help/snapshot
  15. +4 −3 help/tools
  16. +2 −2 help/uninstall
  17. +1 −1 help/upgrade-notes.txt
  18. +8 −8 help/wrapper
View
@@ -1,6 +1,6 @@
Benchmark
-If you have a bit of code that you would like to benchmark across several versions of ruby all at once you can now do this easily with RVM. Given:
+If you have a bit of code that you would like to benchmark, across several versions of ruby all at once, you can now do this easily with RVM. Given:
∴ cat increment.rb
y=0
View
@@ -4,7 +4,6 @@
Performs general cleanup for the specific set of rvm directories.
Useful for reclaiming used disk space from rvm compiles
-and the like.
Examples:
View
@@ -18,16 +18,16 @@ Available colors are:
black red green yellow blue magenta cyan white default
-You can add empasis to the color using bold/offbold.
+You can add emphasis to the color using bold/offbold.
It is also possible to change background color:
bblack bred bgreen byellow bblue bmagenta bcyan bwhite bdefault
On some terminals like xterm ( echo $TERM ) the bold and background colors give the same effect.
-Use comas to put multiple definitions in one color, you can mix color, bold and background in one definition,
-specifying multiple colors/bold/background definitions will use last defined.
+Use commas to put multiple definitions in one color. You can mix color, bold and background in one definition.
+Specifying multiple colors/bold/background definitions will use last defined.
Using bold in one definition requires resetting it in others with offbold.
View
@@ -2,7 +2,7 @@
∴ rvm disk-usage {all,archives,repos,sources,logs,packages,rubies,gemsets}
Returns the amount of disk space used by a specific set of data associated
-with rvm. All returns all of them individually plus the total space used.
+with rvm. All returns each, individually, along with the total space used.
Examples:
View
@@ -11,13 +11,13 @@ To execute 'ruby -v' against all installed rubies and aliases, you would run:
∴ rvm all do ruby -v
-If you instead want to execute it against a specific ruby (without extra logging
+If you want to execute it against a specific ruby (without extra logging
/ data printed by rvm as is done with normal set operations), you can instead do:
∴ rvm ree do ruby -v
Since it is a set operation, normal ruby specifiers will work. As an example, to run
-it against 1.9.2 and 1.8.7, you would run:
+it against 1.9.2 and 1.8.7 you would run:
∴ rvm 1.9.2,1.8.7 do ruby -v
@@ -30,4 +30,4 @@ to the default ruby:
∴ rvm --with-rubies default-with-rvmrc do which ruby
-For more information, look up the rvm set operations.
+For more information, refer to the rvm set operations.
View
@@ -12,7 +12,7 @@ Description:
Commands for working with and manipulating gemsets within RVM.
- Any command is run in context of current ruby/gemset; call 'rvm current' to find out which is used.
+ Any command is run in context of current ruby/gemset; call 'rvm current' to find out which is currently used.
Note that 'system' supports only exporting/importing gems.
@@ -23,8 +23,8 @@ Rejection:
rvm use 1.9.3@my_project --ignore-gemsets
- it will ignore @my_project and @global, only default gemset will be set.
+ it will ignore @my_project and @global - only default gemset will be set.
- It can be done persistent with:
+ It can be persisted with:
echo "export rvm_ignore_gemsets_flag=1" >> ~/.rvmrc
View
@@ -7,7 +7,7 @@ where sections are one of:
Both ruby strings and sections are optional arguments.
-By default with no parameters rvm info will output all sections except debug.
+By default, with no parameters, rvm info will output all sections except debug.
To display system rvm debug information:
View
@@ -9,7 +9,7 @@ ruby.
Examples:
To migrate all gemsets from rc2 of 1.9.2 to the first release, p0,
-you'd run:
+you would run:
∴ rvm migrate 1.9.2-rc2 1.9.2-p0
View
@@ -0,0 +1,4 @@
+
+
+ TODO
+
View
@@ -10,9 +10,9 @@ Rake
JSON Summary
- Adding a --json flag prior to the word 'do' and a JSON summary will be printed out at the end of the run.
+ Add a --json flag prior to the word 'do' and a JSON summary will be printed out at the end of the run.
YAML Summary
- Adding a --yaml flag prior to the word 'do' and a YAML summary will be printed out at the end of the run.
+ Add a --yaml flag prior to the word 'do' and a YAML summary will be printed out at the end of the run.
View
@@ -6,18 +6,18 @@ Runs the repair process(es) against given parts of rvm.
Examples:
To regenerate all of the environment files inside your rvm/environments
-directory, you'd run:
+directory, you would run:
∴ rvm repair environments
-To check for stale symlinks caused by rvm in your rvm_bin_path, you'd run:
+To check for stale symlinks caused by rvm in your rvm_bin_path, you would run:
∴ rvm repair symlinks
-To verify all downloaded archives have the correct md5, you'd run:
+To verify all downloaded archives have the correct md5, you would run:
∴ rvm repair archives
-Or, to do all of the above, you'd run:
+Or, to do all of the above, you can run:
∴ rvm repair all
View
@@ -4,13 +4,14 @@ Installs a specific rubygems version in the current ruby. If
'current' is specified, the most current rubygems known to RVM
will be installed.
-Currently compatible with only MRI 1.8.*, 1.9.* and Ruby
+Currently only compatible with MRI 1.8.*, 1.9.* and Ruby
Enterprise Edition. If your system is not supported, running the
command will generate an error message.
MRI 1.9.* ships with a version of RubyGems. To revert to that version
-after installing a custom version via 'rvm rubygems' run
-'rvm rubygems remove'.
+after installing a custom version via 'rvm rubygems' run:
+
+'rvm rubygems remove'
The version can be also specified as latest-1.8
which will use latest available like 1.8.18
View
@@ -6,7 +6,7 @@ All actions take an optional path to a directory to check.
Examples:
-To check the status of ~/My/project, you'd run:
+To check the status of ~/My/project, you would run:
∴ rvm rvmrc trusted ~/My/project
@@ -23,7 +23,7 @@ Or, to reset the trust and force a prompt:
∴ rvm rvmrc reset ~/My/project
∴ rvm rvmrc reset all
-Finally, to load the rvmrc in a directory, you'd run:
+Finally, to load the rvmrc in a directory, you would run:
∴ rvm rvmrc load ~/My/project
@@ -35,7 +35,7 @@ Note that this replaces 'rvm load-rvmrc'. Note that load implicity trusts the
rvmrc, even if it is set to untrusted.
-Creating project rvmrc files can easily be done with following command:
+Creating project rvmrc files can easily be done with the following command:
∴ rvm --rvmrc --create use 1.9.2@funky
@@ -45,7 +45,7 @@ Or for scripting,
Above command will create both the gemset 'funky', and a project rvmrc file in the current directory.
-From RVM 1.11.0 new project files are available, they do not require trusting:
+From RVM 1.11.0 new project files are available. They do not require trusting:
- ∴ rvm rvmrc create 1.9.2@funky --ruby-version
- ∴ rvm rvmrc create 1.9.2@funky --versions-conf
View
@@ -10,6 +10,7 @@ Saves or creates a snapshot of the given rvm install. This includes:
* Packages
* Your Default
-Ideally to make it easy to have a consistent environment among machines
-/ to back up your environment. Please note that this is still considered
-experimental to a large degree.
+Ideally to easily maintain a consistent environment among machines
+/ to back up your environment.
+
+Please note that this is still considered experimental to a large degree.
View
@@ -1,11 +1,11 @@
∴ rvm tools {identifier,path-identifier,strings,mirror,rvm-env}
-Provides generic tools related to rvm environments for getting information
+Provides generic tools related to rvm environments for gaining information
about your current environment. Primarily used for scripting rvm.
Examples:
-To get the expanded Ruby string for the current environment, we'd run:
+To get the expanded Ruby string for the current environment, you would run:
∴ rvm tools identifier
@@ -42,10 +42,11 @@ Your scripts can then request the proper Ruby, using shebang:
The script will be run using Ruby 1.9.3 from rvm.
-Alternatively, here's a hack to make a script switch itself:
+Alternatively, here is a hack to make a script switch itself:
if !ENV['ruby_switch_flag']
ENV['ruby_switch_flag'] = '42'
system('rvm', '1.9.3', 'do', __FILE__, *ARGV)
exit 0
end
+
View
@@ -1,10 +1,10 @@
∴ rvm uninstall [ruby-string[,ruby-string[,...]]]
-Uninstall one or many ruby versions, but leaves their sources.
+Uninstall one or many ruby versions, but leave their sources.
-For a list of currently install ruby string please run
+For a list of currently installed ruby string please run
rvm list
View
@@ -30,7 +30,7 @@
chmod +x $rvm_path/hooks/after_cd_[hook_name]
chmod -x $rvm_path/hooks/after_use_[hook_name]
- * If your shell exits on entering directory with freshly checked out sources
+ * If your shell exits on entering a directory with freshly checked out sources
you should update .rvmrc file, and replace any `exit ` with `return `.
* If you wish to use RVM in an interactive fashion in other shells
View
@@ -1,12 +1,12 @@
-∴ rvm wrapper [ruby_string] [wrapper_prefix] [binary[ binary[ ...]]]
+∴ rvm wrapper [ruby_string] [wrapper_prefix] [binary[ binaries[ ...]]]
-Where ruby_string is the ruby version and gemset combination to wrap,
-wrapper prefix is what to prepend to the name of the generated wrapper
-binaries and binaries is the names of the binaries you wish to provide
-a wrapper for (e.g. gem).
+Where ruby_string is the ruby version and gemset combination to wrap
+wrapper_prefix is what to prepend to the name of the generated wrapper
+binary and binaries is the names of the binaries for which you wish to
+provide a wrapper (e.g. gem).
-When no binaries are provided, rvm will by default generate wrappers for
+When no binaries are provided, rvm will (by default) generate wrappers for
ruby, gem, rake, irb, rdoc, ri, and testrb.
Examples:
@@ -17,14 +17,14 @@ rails 3 gemset, you could do:
∴ rvm --create ree@rails3
∴ rvm wrapper ree@rails3 r3 spec
-Which would add r3_spec with the specified environment to your the bin
+Which would add r3_spec with the specified environment to the bin
directory where you installed rvm.
Alternatively, if you do:
∴ rvm wrapper ruby-1.9.2-head
-It will create binaries named ruby,gem, rake, irb, rdoc, ri and tesrb
+It will create binaries named ruby, gem, rake, irb, rdoc, ri and tesrb
in the rvm bin directory.
Finally, to show another real and common use, you can use wrapper

0 comments on commit 0f65fda

Please sign in to comment.