summaryrefslogtreecommitdiff
path: root/docs/users_guide/debugging.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/users_guide/debugging.xml')
-rw-r--r--docs/users_guide/debugging.xml10
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/users_guide/debugging.xml b/docs/users_guide/debugging.xml
index aebb928ae8..3d820d65c5 100644
--- a/docs/users_guide/debugging.xml
+++ b/docs/users_guide/debugging.xml
@@ -423,7 +423,15 @@
<indexterm><primary><option>-dshow-passes</option></primary></indexterm>
</term>
<listitem>
- <para>Print out each pass name as it happens.</para>
+ <para>Print out each pass name, its runtime and heap allocations as it happens.
+ Note that this may come at a slight performance cost as the compiler will
+ be a bit more eager in forcing pass results to more accurately account for
+ their costs.
+
+ Two types of messages are produced: Those beginning with ``***`` are
+ denote the beginning of a compilation phase whereas those starting with
+ ``!!!`` mark the end of a pass and are accompanied by allocation and
+ runtime statistics.</para>
</listitem>
</varlistentry>