[Gull-commit] SF.net SVN: gull: [288] doc/trunk/src/documentation/content/xdocs/doc/core. xml

[<bru...@us...>]

Revision: 288
          http://svn.sourceforge.net/gull/?rev=288&view=rev
Author:   bruno_guerin
Date:     2007-07-19 04:53:21 -0700 (Thu, 19 Jul 2007)

Log Message:
-----------
DOC: add Verdict trace level and Return Code signification

Modified Paths:
--------------
    doc/trunk/src/documentation/content/xdocs/doc/core.xml

Modified: doc/trunk/src/documentation/content/xdocs/doc/core.xml
===================================================================
--- doc/trunk/src/documentation/content/xdocs/doc/core.xml	2007-07-19 08:17:18 UTC (rev 287)
+++ doc/trunk/src/documentation/content/xdocs/doc/core.xml	2007-07-19 11:53:21 UTC (rev 288)
@@ -1433,7 +1433,7 @@
         <ul>
           <li>1) <a href="#display-protocol-stat">display-protocol-stat</a>
             <p>Setting this parameter to true enables the protocol statistics. 
-	    If it is not set to true, you will not get any protocol statistics, 
+	    If it is not set to true, you will not get any protocol statistics at screen of in log files, 
 	    even if the following parameters are set.</p>
           </li>
           <li>2) <a href="#log-protocol-stat-period">log-protocol-stat-period</a>
@@ -1605,7 +1605,7 @@
           <strong>W</strong>-Warnings - non blocking errors
             <ul>
               <li>No init scenario</li>
-            <li>No more call context availables</li>
+              <li>No more call context availables</li>
           </ul>
         </li>
         <li>
@@ -1621,6 +1621,16 @@
         <li>
           <strong>B</strong>-Buffer (hex dumps)</li>
         <li>
+          <strong>V</strong>-Verdict (Trace the result of each call with its session-id in the log file) <br/>
+            If the call has no session id, no logs are traced.<br/>
+            Be awared that the session-id may not be unique in the log file.<br/>
+            The "Init" section is considered as a independant call.
+            <ul>
+              <li>passed : call is succesful</li>
+              <li>failed : call is failed</li>
+          </ul>
+        </li>
+        <li>
           <strong>A</strong>-All</li>
         <li>
           <strong>N</strong>-None</li>
@@ -3433,6 +3443,15 @@
 [ -notimelog  ] no time stamp on the log (default time stamp)
 [ -msgcheck  ] check the field of the messages received (default no check)]]></source>
       </section>
+      <section id="cli_return_code">
+        <title>Seagull return code</title>
+        <p>Seagull returns a global status of the calls through the return code:</p>
+        <ul>
+          <li>	0 : ok, seagull did not meet any problems and all calls finished well.</li>
+          <li>	-1 : fatal error, seagull met a fatal error and stopped.</li>
+          <li>	>1 : error, at least, one call failed ("Ignored" calls are not considered as failed; the init section is concidered as a independant call).</li>
+        </ul>
+      </section>
     </section>
     <section>
       <title>Miscellaneous tools</title>
@@ -3444,5 +3463,6 @@
         tool can be used to debug regular expressions (widely used in Seagull!).</li>
       </ul>
     </section>
+
   </body>
 </document>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.