This is an archive of the discontinued LLVM Phabricator instance.

Use dbgs() instead of errs() in docs for DEBUG()
ClosedPublic

Authored by MoritzS on Dec 13 2017, 4:30 AM.

Reviewers

Commits

Summary

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

Thanks, Moritz!

This revision is now accepted and ready to land.Dec 19 2017, 7:40 AM

PS: Let me know if you need me to commit this for you.

Yes, please commit this.

This revision was automatically updated to reflect the committed changes.

Path

Size

docs/

10 lines

Context not available.

	.. code-block:: c++	.. code-block:: c++

	DEBUG(errs() << "I am here!\n");	DEBUG(dbgs() << "I am here!\n");

	Then you can run your pass like this:	Then you can run your pass like this:

Context not available.
	.. code-block:: c++	.. code-block:: c++

	#define DEBUG_TYPE "foo"	#define DEBUG_TYPE "foo"
	DEBUG(errs() << "'foo' debug type\n");	DEBUG(dbgs() << "'foo' debug type\n");
	#undef DEBUG_TYPE	#undef DEBUG_TYPE
	#define DEBUG_TYPE "bar"	#define DEBUG_TYPE "bar"
	DEBUG(errs() << "'bar' debug type\n"));	DEBUG(dbgs() << "'bar' debug type\n");
	#undef DEBUG_TYPE	#undef DEBUG_TYPE

	Then you can run your pass like this:	Then you can run your pass like this:
Context not available.

	.. code-block:: c++	.. code-block:: c++

	DEBUG_WITH_TYPE("foo", errs() << "'foo' debug type\n");	DEBUG_WITH_TYPE("foo", dbgs() << "'foo' debug type\n");
	DEBUG_WITH_TYPE("bar", errs() << "'bar' debug type\n"));	DEBUG_WITH_TYPE("bar", dbgs() << "'bar' debug type\n");

	.. _Statistic:	.. _Statistic:

Context not available.