kamailio/modules/malloc_test/doc/malloc_test.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
	"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
	[ <!ENTITY % local.common.attrib
	 "xmlns:xi CDATA #FIXED 'http://www.w3.org/2001/XInclude'">
	 <!-- Include general documentation entities -->
	 <!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
	 %docentities;
	]
>

<book id="malloc_test" xmlns:xi="http://www.w3.org/2001/XInclude">
	<bookinfo>
		<title>The malloc_test Module</title>
		<authorgroup>
			<author>
				<firstname>Andrei</firstname>
				<surname>Pelinescu-Onciul</surname>
				<affiliation><orgname>iptelorg GmbH</orgname></affiliation>
			<address>
				<email>[email protected]</email>
			</address>
			</author>
		</authorgroup>
		<copyright>
			<year>2010</year>
			<holder>iptelorg GmbH</holder>
		</copyright>
	</bookinfo>
	<toc></toc>

	<chapter>
	<title>Admin Guide</title>
	<section id="malloc_test.overview">
		<title>Overview</title>
		<para>
			This is a debugging/test module. It implements functions (both
			script and rpcs) that can be used to stress the memory allocator
			or force memory leaks.
		</para>
		<warning><para>
			This module should never be used in a production environment.
		</para></warning>
	</section>
	<xi:include href="malloc_test_params.xml"/>
	<xi:include href="malloc_test_functions.xml"/>
	<xi:include href="malloc_test_rpc.xml"/>
	</chapter>
</book>