doc: util: document --trace-deprecation

Document the --trace-deprecation flag and the `process` properties that affect util.deprecate(). Fixes: #190 PR-URL: #191 Reviewed-By: Jonathan Ong <[email protected]>
nodejs · Dec 30, 2014 · 8b04161 · 8b04161
1 parent d8586ea
commit 8b04161
Showing 1 changed file with 15 additions and 4 deletions.
diff --git a/doc/api/util.markdown b/doc/api/util.markdown
@@ -267,10 +267,21 @@ Marks that a method should not be used any more.
       }
     }, 'util.puts: Use console.log instead')
 
-It returns a modified function which warns once by default. If
-`--no-deprecation` is set then this function is a NO-OP. If
-`--throw-deprecation` is set then the application will throw an exception
-if the deprecated API is used.
+It returns a modified function which warns once by default.
+
+If `--no-deprecation` is set then this function is a NO-OP.  Configurable
+at run-time through the `process.noDeprecation` boolean (only effective
+when set before a module is loaded.)
+
+If `--trace-deprecation` is set, a warning and a stack trace are logged
+to the console the first time the deprecated API is used.  Configurable
+at run-time through the `process.traceDeprecation` boolean.
+
+If `--throw-deprecation` is set then the application throws an exception
+when the deprecated API is used.  Configurable at run-time through the
+`process.throwDeprecation` boolean.
+
+`process.throwDeprecation` takes precedence over `process.traceDeprecation`.
 
 ## util.debug(string)