From 8417027c1ed8bf2f48340ded6329b47663fe9988 Mon Sep 17 00:00:00 2001
From: Bill Medland <Bill.Medland@accpac.com>
Date: Sat, 19 Oct 2002 01:00:04 +0000
Subject: [PATCH] Add documentation on how to modify what --debugmsg +relay
 reports.

---
 documentation/configuring.sgml | 37 +++++++++++++++++++++++++++-------
 documentation/running.sgml     |  6 +++++-
 2 files changed, 35 insertions(+), 8 deletions(-)

diff --git a/documentation/configuring.sgml b/documentation/configuring.sgml
index 5130c5940cb..0b575ec0452 100644
--- a/documentation/configuring.sgml
+++ b/documentation/configuring.sgml
@@ -129,7 +129,7 @@
                 <entry>Direct port access</entry>
               </row>
               <row>
-                <entry>[spy]</entry>
+                <entry>[Debug]</entry>
                 <entry>no</entry>
                 <entry>What to do with certain debug messages</entry>
               </row>
@@ -807,13 +807,16 @@ OPTIONAL:
           </para>
         </sect3>
 
-        <sect3>
-          <title>The [spy], [Registry], [tweak.layout], and [programs] Sections</title>
+        <sect3 id="config-debug-etc">
+          <title>The [Debug], [Registry], [tweak.layout], and [programs] Sections</title>
           <para>
-            [spy] is used to include or exclude debug messages, and to
+            [Debug] is used to include or exclude debug messages, and to
             output them to a file. The latter is rarely used. THESE
             ARE ALL OPTIONAL AND YOU PROBABLY DON'T NEED TO ADD OR
-            REMOVE ANYTHING IN THIS SECTION TO YOUR CONFIG.
+            REMOVE ANYTHING IN THIS SECTION TO YOUR CONFIG.  (In extreme
+            cases you may want to use these options to manage the amount
+            of information generated by the <parameter>--debugmsg +relay
+            </parameter> option.)
           </para>
           <para>
             <programlisting>"File" = "/blanco"</programlisting>
@@ -821,15 +824,35 @@ OPTIONAL:
             THIS IS RARELY USED.
           </para>
           <para>
-            <programlisting>"Exclude" = "WM_SIZE;WM_TIMER;"</programlisting>
+            <programlisting>"SpyExclude" = "WM_SIZE;WM_TIMER;"</programlisting>
             Excludes debug messages about <constant>WM_SIZE</constant>
             and <constant>WM_TIMER</constant> in the logfile.
           </para>
           <para>
-            <programlisting>"Include" = "WM_SIZE;WM_TIMER;"</programlisting>
+            <programlisting>"SpyInclude" = "WM_SIZE;WM_TIMER;"</programlisting>
             Includes debug messages about <constant>WM_SIZE</constant>
             and <constant>WM_TIMER</constant> in the logfile.
           </para>
+          <para>
+            <programlisting>"RelayInclude" = "user32.CreateWindowA;comctl32.*"</programlisting>
+            Include only the listed functions in a
+            <parameter>--debugmsg +relay</parameter> trace.  This entry is
+            ignored if there is a <parameter>RelayExclude</parameter> entry.
+          </para>
+          <para>
+            <programlisting>"RelayExclude" = "RtlEnterCriticalSection;RtlLeaveCriticalSection"</programlisting>
+            Exclude the listed functions in a 
+            <parameter>--debugmsg +relay</parameter> trace.  This entry
+            overrides any settings in a <parameter>RelayInclude</parameter>
+            entry.  If neither entry is present then the trace includes
+            everything.
+          </para>
+          <para>
+            In both entries the functions may be specified either as a 
+            function name or as a module and function.  In this latter
+            case specify an asterisk for the function name to include
+            all functions in the module.
+          </para>
           <para>
             [Registry] can be used to tell wine where your old windows
             registry files exist. This section is completely optional
diff --git a/documentation/running.sgml b/documentation/running.sgml
index e49af31381c..05ca587b53e 100644
--- a/documentation/running.sgml
+++ b/documentation/running.sgml
@@ -112,7 +112,11 @@ Options:
           complex application, your debug logs can easily top 1 MB and
           higher.  A <parameter>relay</parameter> trace can often
           generate more than 10 MB of log messages, depending on how
-          long you run the application.  Logging does slow down Wine
+          long you run the application.  (As described in the
+          <link linkend = "config-debug-etc">Debug</link>
+          section of configuring wine you can 
+          modify what the <parameter>relay</parameter> trace reports).
+          Logging does slow down Wine
           quite a bit, so don't use <parameter>--debugmsg</parameter>
           unless you really do want log files.
         </para>