[Gnash-commit] gnash ChangeLog doc/C/refmanual/logging.xml

[Benjamin Wolsey]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     Benjamin Wolsey <bwy>   08/05/08 11:33:05

Modified files:
        .              : ChangeLog 
        doc/C/refmanual: logging.xml 

Log message:
        Docs update.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&r1=1.6553&r2=1.6554
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/refmanual/logging.xml?cvsroot=gnash&r1=1.3&r2=1.4

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.6553
retrieving revision 1.6554
diff -u -b -r1.6553 -r1.6554
--- ChangeLog   8 May 2008 10:45:25 -0000       1.6553
+++ ChangeLog   8 May 2008 11:33:04 -0000       1.6554
@@ -16,6 +16,10 @@
        
 2008-05-08 Benjamin Wolsey <address@hidden>
 
+       * docs: update logging info in refmanual.
+
+2008-05-08 Benjamin Wolsey <address@hidden>
+
        * server/parser/action_buffer.cpp: it's a vector, use push_back.
        * server/swf/PlaceObject2Tag.cpp: use ensureBytes, drop
          assertion, with comment: rely on action_buffer's safety.

Index: doc/C/refmanual/logging.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/refmanual/logging.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -b -r1.3 -r1.4
--- doc/C/refmanual/logging.xml 17 Mar 2008 15:58:08 -0000      1.3
+++ doc/C/refmanual/logging.xml 8 May 2008 11:33:05 -0000       1.4
@@ -3,9 +3,8 @@
   
   <para>
     &app;'s common message logging system uses a <emphasis>printf()</emphasis>
-    style format. C++ iostream logging functions were introduced alongside, 
but this has since
-    largely been abandoned. Despite the C-like appearance, however, &app;'s 
LogFile class
-    by default does not use <emphasis>printf()</emphasis> for formatting at 
all the
+    style format. Despite the C-like appearance, however, &app;'s LogFile class
+    by default does not use <emphasis>printf()</emphasis> for formatting the
     messages at all.
   </para>
   
@@ -18,21 +17,11 @@
     used to format the log output.
   </para>  
   
-  <sect3 id="status">
-  <title>Status</title>  
   <para>
-    Currently, &app; is preserving the option of returning to the previous
-    <emphasis>printf()</emphasis> implementation. While it is possible to use
-    std::strings and even custom types
-    in substitutions, and <emphasis>boost::format</emphasis> style positional
-    identifiers (%1%, %2%, %1%)
-    in the format string, this is inadvisable as it would break any move back 
to
-    <emphasis>printf()</emphasis>.
-  </para>   
-
-  <para>
-    It is possible to switch between the different logging format functions 
simply by
-    changing <emphasis>#define USE_BOOST_FORMAT_TEMPLATES</emphasis> in log.h. 
+    The templates for conversion are generated using Boost.Preprocessor. 
Currently,
+    they allow for a maximum of 16 arguments (more than enough for all current 
+    usage), but that can be expanded or reduced by changing 
+    <emphasis>#define ARG_NUMBER</emphasis> in 
<emphasis>libbase/log.h</emphasis>.
   </para>   
 
   <para>
@@ -45,7 +34,7 @@
     can be specified using either <emphasis>gnashrc</emphasis> or a 
     call to the LogFile instance itself.
   </para>
-    </sect3>
+
   <sect3 id="api">
     <title>Logging System API</title>
 
@@ -193,7 +182,7 @@
        </listitem>
       </varlistentry>
       <varlistentry>
-       <term>setLogFilename(const std::string&amp; fname)</term>
+       <term>setLogFilename(const std::string&amp; filename)</term>
        <listitem>
          <para>
            Use this to set a different name for the disk-based log file.
@@ -205,7 +194,7 @@
       </varlistentry>
 
       <varlistentry>
-       <term>closeLog(void)</term>
+       <term>closeLog()</term>
        <listitem>
          <para>
            Close a debug log. The disk file remains.
@@ -213,7 +202,7 @@
        </listitem>
       </varlistentry>
       <varlistentry>
-       <term>removeLog(void)</term>
+       <term>removeLog()</term>
        <listitem>
          <para>
            Delete the debug log file from disk.
@@ -221,7 +210,7 @@
        </listitem>
       </varlistentry>
       <varlistentry>
-       <term>setVerbosity(void)</term>
+       <term>setVerbosity()</term>
        <listitem>
          <para>
            Increment the verbosity level.
@@ -229,7 +218,7 @@
        </listitem>
       </varlistentry>
       <varlistentry>
-       <term>setVerbosity(int)</term>
+       <term>setVerbosity(int level)</term>
        <listitem>
          <para>
            Set the verbosity level to a specified level.