malloc_test: new module for testing/debugging memory problems
[sip-router] / modules / malloc_test / doc / malloc_test.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
4         [ <!ENTITY % local.common.attrib
5          "xmlns:xi CDATA #FIXED 'http://www.w3.org/2001/XInclude'">]
6 >
7
8 <section id="malloc_test" xmlns:xi="http://www.w3.org/2001/XInclude">
9         <sectioninfo>
10                 <authorgroup>
11                         <author>
12                                 <firstname>Andrei</firstname>
13                                 <surname>Pelinescu-Onciul</surname>
14                                 <affiliation><orgname>iptelorg GmbH</orgname></affiliation>
15                         <address>
16                                 <email>andrei@iptel.org</email>
17                         </address>
18                         </author>
19                 </authorgroup>
20                 <copyright>
21                         <year>2010</year>
22                         <holder>iptelorg GmbH</holder>
23                 </copyright>
24                 <revhistory>
25                         <revision>
26                         <revnumber>$Revision$</revnumber>
27                         <date>$Date$</date>
28                         </revision>
29                 </revhistory>
30         </sectioninfo>
31
32         <title>malloc_test Module</title>
33
34         <section id="malloc_test.overview">
35                 <title>Overview</title>
36                 <para>
37                         This is a debugging/test module. It implements functions (both
38                         script and rpcs) that can be used to stress the memory allocator
39                         or force memory leaks.
40                 </para>
41                 <warning><para>
42                         This module should never be used in a production environment.
43                 </para></warning>
44         </section>
45         <xi:include href="params.xml"/>
46         <xi:include href="functions.xml"/>
47 </section>