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.

Download Raw Diff

Details

Reviewers

Commits

rGed8d2bc5c6cf: [docs] Use dbgs() instead of errs() for DEBUG()
rL321444: [docs] Use dbgs() instead of errs() for DEBUG()

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.

Diff Detail

Repository: rL LLVM

Event Timeline

MoritzS created this revision.Dec 13 2017, 4:30 AM

Herald added a subscriber: JDevlieghere. · View Herald TranscriptDec 13 2017, 4:30 AM

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.

Closed by commit rL321444: [docs] Use dbgs() instead of errs() for DEBUG() (authored by JDevlieghere). · Explain WhyDec 25 2017, 6:16 AM

This revision was automatically updated to reflect the committed changes.

Revision Contents

Path

Size

llvm/

trunk/

docs/

ProgrammersManual.rst

10 lines

Diff 128140

llvm/trunk/docs/ProgrammersManual.rst

	Show First 20 Lines • Show All 1,034 Lines • ▼ Show 20 Lines
	<http://llvm.org/doxygen/Debug_8h_source.html>`__) file provides a macro named			<http://llvm.org/doxygen/Debug_8h_source.html>`__) file provides a macro named
	``DEBUG()`` that is a much nicer solution to this problem. Basically, you can			``DEBUG()`` that is a much nicer solution to this problem. Basically, you can
	put arbitrary code into the argument of the ``DEBUG`` macro, and it is only			put arbitrary code into the argument of the ``DEBUG`` macro, and it is only
	executed if '``opt``' (or any other tool) is run with the '``-debug``' command			executed if '``opt``' (or any other tool) is run with the '``-debug``' command
	line argument:			line argument:

	.. 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:

	.. code-block:: none			.. code-block:: none

	$ opt < a.bc > /dev/null -mypass			$ opt < a.bc > /dev/null -mypass
	<no output>			<no output>
	$ opt < a.bc > /dev/null -mypass -debug			$ opt < a.bc > /dev/null -mypass -debug
	Show All 19 Lines
	turns on too much information (such as when working on the code generator).			turns on too much information (such as when working on the code generator).
	If you want to enable debug information with more fine-grained control, you			If you want to enable debug information with more fine-grained control, you
	should define the ``DEBUG_TYPE`` macro and use the ``-debug-only`` option as			should define the ``DEBUG_TYPE`` macro and use the ``-debug-only`` option as
	follows:			follows:

	.. 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:

	.. code-block:: none			.. code-block:: none

	$ opt < a.bc > /dev/null -mypass			$ opt < a.bc > /dev/null -mypass
	<no output>			<no output>
	Show All 24 Lines

	The ``DEBUG_WITH_TYPE`` macro is also available for situations where you would			The ``DEBUG_WITH_TYPE`` macro is also available for situations where you would
	like to set ``DEBUG_TYPE``, but only for one specific ``DEBUG`` statement. It			like to set ``DEBUG_TYPE``, but only for one specific ``DEBUG`` statement. It
	takes an additional first parameter, which is the type to use. For example, the			takes an additional first parameter, which is the type to use. For example, the
	preceding example could be written as:			preceding example could be written as:

	.. 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:

	The ``Statistic`` class & ``-stats`` option			The ``Statistic`` class & ``-stats`` option
	-------------------------------------------			-------------------------------------------

	The ``llvm/ADT/Statistic.h`` (`doxygen			The ``llvm/ADT/Statistic.h`` (`doxygen
	<http://llvm.org/doxygen/Statistic_8h_source.html>`__) file provides a class			<http://llvm.org/doxygen/Statistic_8h_source.html>`__) file provides a class
	▲ Show 20 Lines • Show All 2,994 Lines • Show Last 20 Lines