Bladeren bron

siptrace: fix order of parameter for sip_trace function, add listitem structure

Henning Westerholt 6 jaren geleden
bovenliggende
commit
803476627d
1 gewijzigde bestanden met toevoegingen van 9 en 5 verwijderingen
  1. 9 5
      src/modules/siptrace/doc/siptrace_admin.xml

+ 9 - 5
src/modules/siptrace/doc/siptrace_admin.xml

@@ -515,7 +515,7 @@ modparam("siptrace", "auth_key", "spoihepuirthpeuia")
 	<title>Functions</title>
 	<title>Functions</title>
 	<section id="siptrace.f.sip_trace">
 	<section id="siptrace.f.sip_trace">
 		<title>
 		<title>
-		<function moreinfo="none">sip_trace([mode][,address][, correlation_id])</function>
+		<function moreinfo="none">sip_trace([address][,correlation_id][,mode])</function>
 		</title>
 		</title>
 		<para>
 		<para>
 		Store or forward the current processed SIP message/transaction/dialog in database.
 		Store or forward the current processed SIP message/transaction/dialog in database.
@@ -525,19 +525,23 @@ modparam("siptrace", "auth_key", "spoihepuirthpeuia")
 		<para>Meaning of the parameters is as follows:</para>
 		<para>Meaning of the parameters is as follows:</para>
 		<itemizedlist>
 		<itemizedlist>
 		<listitem>
 		<listitem>
-		<para><emphasis>mode</emphasis> - SIP messages to be traced. One can trace the current message
-		(function can be called on either a reply or a request), the current transaction(the route must
-		belong to a request) or the current dialog(the message has to be an invite).
-		</para>
 		<para><emphasis>address</emphasis> - The address in form of SIP URI
 		<para><emphasis>address</emphasis> - The address in form of SIP URI
 		where to send a duplicate of traced message. This parameter trumps
 		where to send a duplicate of traced message. This parameter trumps
 		duplicate_uri and allows tracing to more than one server.
 		duplicate_uri and allows tracing to more than one server.
 		</para>
 		</para>
+		</listitem>
+		<listitem>
 		<para><emphasis>correlation_id</emphasis> - A string with a correlation ID
 		<para><emphasis>correlation_id</emphasis> - A string with a correlation ID
 		to be added to the HEP header when using HEPv3.
 		to be added to the HEP header when using HEPv3.
 		It's possible to use PVs.
 		It's possible to use PVs.
 		</para>
 		</para>
 		</listitem>
 		</listitem>
+		<listitem>
+		<para><emphasis>mode</emphasis> - SIP messages to be traced. One can trace the current message
+		(function can be called on either a reply or a request), the current transaction(the route must
+		belong to a request) or the current dialog(the message has to be an invite).
+		</para>
+		</listitem>
 		</itemizedlist>
 		</itemizedlist>
 		<para>
 		<para>
 		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
 		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,