On 24/07/07, [EMAIL PROTECTED] <[EMAIL PROTECTED]> wrote:
Author: noodl
Date: Tue Jul 24 03:54:35 2007
New Revision: 559006

URL: http://svn.apache.org/viewvc?view=rev&rev=559006
Log:
[PR36917] Document pre-2.2.4 behaviour of mod_dumpio

Modified:
    httpd/httpd/trunk/docs/manual/mod/mod_dumpio.html.en
    httpd/httpd/trunk/docs/manual/mod/mod_dumpio.xml

Modified: httpd/httpd/trunk/docs/manual/mod/mod_dumpio.html.en
URL: 
http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_dumpio.html.en?view=diff&rev=559006&r1=559005&r2=559006
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_dumpio.html.en (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_dumpio.html.en Tue Jul 24 03:54:35 
2007
@@ -95,6 +95,9 @@
     <div class="example"><h3>Example</h3><p><code>
       DumpIOLogLevel notice
     </code></p></div>
+
+    <div class="note"><h3>Compatibility</h3>Prior to 2.2.4 <code class="module"><a 
href="../mod/mod_dumpio.html">mod_dumpio</a></code>
+    would only dump to the log when <code class="directive"><a 
href="../mod/core.html#loglevel">LogLevel</a></code> was set to <code>debug</code></div>

 </div>
 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" 
/></a></div>

Modified: httpd/httpd/trunk/docs/manual/mod/mod_dumpio.xml
URL: 
http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_dumpio.xml?view=diff&rev=559006&r1=559005&r2=559006
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_dumpio.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_dumpio.xml Tue Jul 24 03:54:35 2007
@@ -105,6 +105,10 @@
     <example><title>Example</title>
       DumpIOLogLevel notice
     </example>
+
+    <note><title>Compatibility</title>Prior to 2.2.4 
<module>mod_dumpio</module>
+    would only dump to the log when <directive
+    module="core">LogLevel</directive> was set to <code>debug</code></note>
 </usage>

 </directivesynopsis>


Hey,

I'm planning to try and address one docs bug a day. This one (PR
36917) is easy but I've got a few questions regarding r559006, r559008
& r559009.

- Is this a suitable way to document compatibility issues inline?
(<note> in <usage>)
- Should the trunk docs _not_ have this note (given that all 2.4
versions will have this DumpIOLogLevel)? Or perhaps change 2.2.4 to
whichever 2.3 revision was current?
- Is the language ok? I find it tricky picking the correct tense
between "<old rev> would only do X if Y was set to Z" .. and .. "<old
rev> will only do X if Y is set to Z"

--
noodl

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to