* doc/globals.rdoc: Document what setting $DEBUG does.

* doc/globals.rdoc:  Added pointer to $-d for full documentation.


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

ChangeLog

@@ -1,3 +1,9 @@
+Fri Feb 22 06:30:57 2013  Eric Hodel  <drbrain@segment7.net>
+
+	* doc/globals.rdoc:  Document what setting $DEBUG does.
+
+	* doc/globals.rdoc:  Added pointer to $-d for full documentation.
+
 Fri Feb 22 06:27:07 2013  Eric Hodel  <drbrain@segment7.net>
 
 	* doc/globals.rdoc:  Document what setting $VERBOSE does.  [Bug #7899]

doc/globals.rdoc

@@ -25,7 +25,11 @@ $$::   The process number of the Ruby running this script.
 $?::   The status of the last executed child process.
 $:::   Load path for scripts and binary modules by load or require.
 $"::   The array contains the module names loaded by require.
-$DEBUG::     The status of the -d switch.
+$DEBUG::     The debug flag, which is set by the -d switch.  Enabling debug
+             output prints each exception raised to $stderr (but not its
+             backtrace).  Setting this to a true value enables debug output as
+             if -d were given on the command line.  Setting this to a false
+             value disables debug output.
 $FILENAME::  Current input file from $<. Same as $<.filename.
 $LOAD_PATH:: The alias to the $:.
 $stderr::    The current standard error output.
@@ -37,7 +41,7 @@ $VERBOSE::   The verbose flag, which is set by the -w or -v switch.  Setting
              including from Kernel#warn.
 $-0::  The alias to $/.
 $-a::  True if option -a is set. Read-only variable.
-$-d::  The alias to $DEBUG.
+$-d::  The alias of $DEBUG.  See $DEBUG above for further discusison.
 $-F::  The alias to $;.
 $-i::  In in-place-edit mode, this variable holds the extension, otherwise nil.
 $-I::  The alias to $:.