* doc/globals.rdoc: Document what setting $VERBOSE does. [Bug #7899]

* doc/globals.rdoc:  Added pointer to $-w and $-v for full
  documentation.


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@39364 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

1 files changed, 6 insertions, 3 deletions

diff --git a/doc/globals.rdoc b/doc/globals.rdoc
index 379acea7cf..f4cfd35ef6 100644
--- a/doc/globals.rdoc
+++ b/doc/globals.rdoc
@@ -31,7 +31,10 @@ $LOAD_PATH:: The alias to the $:.
 $stderr::    The current standard error output.
 $stdin::     The current standard input.
 $stdout::    The current standard output.
-$VERBOSE::   The verbose flag, which is set by the -v switch.
+$VERBOSE::   The verbose flag, which is set by the -w or -v switch.  Setting
+             this to a true value enables warnings as if -w or -v were given
+             on the command line.  Setting this to nil disables warnings,
+             including from Kernel#warn.
 $-0::  The alias to $/.
 $-a::  True if option -a is set. Read-only variable.
 $-d::  The alias to $DEBUG.
@@ -40,8 +43,8 @@ $-i::  In in-place-edit mode, this variable holds the extension, otherwise nil.
 $-I::  The alias to $:.
 $-l::  True if option -l is set. Read-only variable.
 $-p::  True if option -p is set. Read-only variable.
-$-v::  The alias to $VERBOSE.
-$-w::  True if option -w is set.
+$-v::  An alias of $VERBOSE.  See $VERBOSE above for further discussion.
+$-w::  An alias of $VERBOSE.  See $VERBOSE above for further discussion.
 
 == Pre-defined global constants