summaryrefslogtreecommitdiff
path: root/docs/html/gsignond-Logging.html
diff options
context:
space:
mode:
authorAmarnath Valluri <amarnath.valluri@linux.intel.com>2013-08-22 15:27:24 +0300
committerAmarnath Valluri <amarnath.valluri@linux.intel.com>2013-08-22 16:59:26 +0300
commit1fd618eee96db111f3eea0806eccb8cf2ad91106 (patch)
treea5536e388228a0a1e51ffe8a49e0fc007d0074da /docs/html/gsignond-Logging.html
parente9a79beef3cd891ac16bae05a28c91c613df6442 (diff)
downloadgsignond-1fd618eee96db111f3eea0806eccb8cf2ad91106.tar.gz
gsignond-1fd618eee96db111f3eea0806eccb8cf2ad91106.tar.bz2
gsignond-1fd618eee96db111f3eea0806eccb8cf2ad91106.zip
Diffstat (limited to 'docs/html/gsignond-Logging.html')
-rw-r--r--docs/html/gsignond-Logging.html177
1 files changed, 177 insertions, 0 deletions
diff --git a/docs/html/gsignond-Logging.html b/docs/html/gsignond-Logging.html
new file mode 100644
index 0000000..074a419
--- /dev/null
+++ b/docs/html/gsignond-Logging.html
@@ -0,0 +1,177 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Logging</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="index.html" title="gsignond API Reference Manual">
+<link rel="up" href="ch06.html" title="Miscellaneous">
+<link rel="prev" href="gsignond-Errors.html" title="Errors">
+<link rel="next" href="gsignond-Utility-functions.html" title="Utility functions">
+<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
+<td width="100%" align="left">
+<a href="#" class="shortcut">Top</a>
+  | 
+ <a href="#gsignond-Logging.description" class="shortcut">Description</a>
+</td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
+<td><a accesskey="u" href="ch06.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<td><a accesskey="p" href="gsignond-Errors.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
+<td><a accesskey="n" href="gsignond-Utility-functions.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="refentry">
+<a name="gsignond-Logging"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="gsignond-Logging.top_of_page"></a>Logging</span></h2>
+<p>Logging — logging facilities</p>
+</td>
+<td valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsynopsisdiv">
+<a name="gsignond-Logging.synopsis"></a><h2>Synopsis</h2>
+<pre class="synopsis">
+#include &lt;gsignond/gsignond-log.h&gt;
+
+#define <a class="link" href="gsignond-Logging.html#DBG:CAPS" title="DBG()">DBG</a> (frmt,
+ ...)
+#define <a class="link" href="gsignond-Logging.html#ERR:CAPS" title="ERR()">ERR</a> (frmt,
+ ...)
+#define <a class="link" href="gsignond-Logging.html#INFO:CAPS" title="INFO()">INFO</a> (frmt,
+ ...)
+#define <a class="link" href="gsignond-Logging.html#TRACEBACK:CAPS" title="TRACEBACK">TRACEBACK</a>
+#define <a class="link" href="gsignond-Logging.html#WARN:CAPS" title="WARN()">WARN</a> (frmt,
+ ...)
+</pre>
+</div>
+<div class="refsect1">
+<a name="gsignond-Logging.description"></a><h2>Description</h2>
+<p>
+<code class="filename">gsignond/gsignond-log.h</code> file contains logging macros
+that plugins and extensions should use for debugging and tracing.
+</p>
+<p>
+For example:
+</p>
+<div class="informalexample">
+ <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
+ <tbody>
+ <tr>
+ <td class="listing_lines" align="right"><pre>1</pre></td>
+ <td class="listing_code"><pre class="programlisting">INFO(<span class="number">&quot;Plugin </span><span class="symbol">%s</span><span class="number"> initialized&quot;</span>, plugin_mechanism);</pre></td>
+ </tr>
+ </tbody>
+ </table>
+</div>
+
+<p>
+</p>
+</div>
+<div class="refsect1">
+<a name="gsignond-Logging.details"></a><h2>Details</h2>
+<div class="refsect2">
+<a name="DBG:CAPS"></a><h3>DBG()</h3>
+<pre class="programlisting">#define DBG(frmt, args...)</pre>
+<p>
+Use this macro to log debug messages. GSignond will take care of
+correctly saving them.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>frmt</code></em> :</span></p></td>
+<td>format string for the message</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
+<td>arguments for the format string</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ERR:CAPS"></a><h3>ERR()</h3>
+<pre class="programlisting">#define ERR(frmt, args...)</pre>
+<p>
+Use this macro to log error messages. GSignond will take care of
+correctly saving them.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>frmt</code></em> :</span></p></td>
+<td>format string for the message</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
+<td>arguments for the format string</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="INFO:CAPS"></a><h3>INFO()</h3>
+<pre class="programlisting">#define INFO(frmt, args...)</pre>
+<p>
+Use this macro to log informational messages. GSignond will take care of
+correctly saving them.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>frmt</code></em> :</span></p></td>
+<td>format string for the message</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
+<td>arguments for the format string</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="TRACEBACK:CAPS"></a><h3>TRACEBACK</h3>
+<pre class="programlisting">#define TRACEBACK()</pre>
+<p>
+This macro prints the current function call stack to stderr.
+</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="WARN:CAPS"></a><h3>WARN()</h3>
+<pre class="programlisting">#define WARN(frmt, args...)</pre>
+<p>
+Use this macro to log warning messages. GSignond will take care of
+correctly saving them.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>frmt</code></em> :</span></p></td>
+<td>format string for the message</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
+<td>arguments for the format string</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+ Generated by GTK-Doc V1.19.1</div>
+</body>
+</html> \ No newline at end of file