[PATCH] D41170: Use dbgs() instead of errs() in docs for DEBUG()

Moritz Sichert via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Wed Dec 13 04:30:33 PST 2017


MoritzS created this revision.
Herald added a subscriber: JDevlieghere.

The examples in llvm/Support/Debug.h use DEBUG(dbgs() << ...) instead of errs(), so the examples in the Programmer's Manual should match that.


https://reviews.llvm.org/D41170

Files:
  docs/ProgrammersManual.rst


Index: docs/ProgrammersManual.rst
===================================================================
--- docs/ProgrammersManual.rst
+++ docs/ProgrammersManual.rst
@@ -1040,7 +1040,7 @@
 
 .. code-block:: c++
 
-  DEBUG(errs() << "I am here!\n");
+  DEBUG(dbgs() << "I am here!\n");
 
 Then you can run your pass like this:
 
@@ -1076,10 +1076,10 @@
 .. code-block:: c++
 
   #define DEBUG_TYPE "foo"
-  DEBUG(errs() << "'foo' debug type\n");
+  DEBUG(dbgs() << "'foo' debug type\n");
   #undef  DEBUG_TYPE
   #define DEBUG_TYPE "bar"
-  DEBUG(errs() << "'bar' debug type\n"));
+  DEBUG(dbgs() << "'bar' debug type\n");
   #undef  DEBUG_TYPE
 
 Then you can run your pass like this:
@@ -1120,8 +1120,8 @@
 
 .. code-block:: c++
 
-  DEBUG_WITH_TYPE("foo", errs() << "'foo' debug type\n");
-  DEBUG_WITH_TYPE("bar", errs() << "'bar' debug type\n"));
+  DEBUG_WITH_TYPE("foo", dbgs() << "'foo' debug type\n");
+  DEBUG_WITH_TYPE("bar", dbgs() << "'bar' debug type\n");
 
 .. _Statistic:
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D41170.126724.patch
Type: text/x-patch
Size: 987 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20171213/25ac4a39/attachment.bin>


More information about the llvm-commits mailing list