malloc_test: new module for testing/debugging memory problems
[sip-router] / modules / malloc_test / doc / params.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
5 <section id="malloc_test.parameters" xmlns:xi="http://www.w3.org/2001/XInclude">
6         <sectioninfo>
7                 <revhistory>
8                         <revision>
9                                 <revnumber>$Revision$</revnumber>
10                                 <date>$Date$</date>
11                         </revision>
12                 </revhistory>
13         </sectioninfo>
14         <title>Parameters</title>
15
16         <section id="check_content">
17                 <title><varname>check_content</varname></title>
18                 <para>
19                         When doing the tests, check also for the possibility of the
20                         memory being overwritten. When activated, the allocated memory
21                         will be filled with a special pattern, that will be checked on
22                         free.
23                 </para>
24                 <para>
25                         Default: 0 (off).
26                 </para>
27                 <para>
28                         It can be changed also at runtime, via the rpc interface.
29                 </para>
30                 <example>
31                         <title>
32                                 Set <varname>check_content</varname> in the config file
33                         </title>
34                         <programlisting>
35 modparam("malloc_test", "check_content", 1)
36                         </programlisting>
37                 </example>
38                 <example>
39                         <title>
40                                 Set <varname>check_content</varname> at runtime via sercmd
41                         </title>
42                         <programlisting>
43 $ sercmd cfg.set_now_int malloc_test check_content 1
44                         </programlisting>
45                 </example>
46         </section>
47
48 </section>