ソースを参照

domainpolicy: removed empty rpc section

- added several section ids
Daniel-Constantin Mierla 8 年 前
コミット
d94a65cbd0
1 ファイル変更36 行追加42 行削除
  1. 36 42
      src/modules/domainpolicy/doc/domainpolicy_admin.xml

+ 36 - 42
src/modules/domainpolicy/doc/domainpolicy_admin.xml

@@ -50,13 +50,13 @@
 
 
 	<section>
 	<section>
 	<title>Parameters</title>
 	<title>Parameters</title>
-	<section>
+	<section id="dompolicy.p.db_url">
 		<title><varname>db_url</varname> (string)</title>
 		<title><varname>db_url</varname> (string)</title>
 		<para>
 		<para>
 		This is <acronym>URL</acronym> of the database to be used.
 		This is <acronym>URL</acronym> of the database to be used.
 		</para>
 		</para>
 		<para>
 		<para>
-		Default value is 
+		Default value is
 			<quote>&defaultdb;</quote>
 			<quote>&defaultdb;</quote>
 		</para>
 		</para>
 		<example>
 		<example>
@@ -66,7 +66,7 @@ modparam("domainpolicy", "db_url", "&exampleotherdb;")
 		</programlisting>
 		</programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="dompolicy.p.dp_table">
 		<title><varname>dp_table</varname> (string)</title>
 		<title><varname>dp_table</varname> (string)</title>
 		<para>
 		<para>
 		Name of table containing the local support domain policy setup.
 		Name of table containing the local support domain policy setup.
@@ -81,7 +81,7 @@ modparam("domainpolicy", "dp_table", "supportedpolicies")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="dompolicy.p.col_rule">
 		<title><varname>dp_col_rule</varname> (string)</title>
 		<title><varname>dp_col_rule</varname> (string)</title>
 		<para>
 		<para>
 		Name of column containing the domain policy rule name which is equal
 		Name of column containing the domain policy rule name which is equal
@@ -97,7 +97,7 @@ modparam("domainpolicy", "dp_col_rule", "rules")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="dompolicy.p.col_type">
 		<title><varname>dp_col_type</varname> (string)</title>
 		<title><varname>dp_col_type</varname> (string)</title>
 		<para>
 		<para>
 		Name of column containing the domain policy rule type.
 		Name of column containing the domain policy rule type.
@@ -117,7 +117,7 @@ modparam("domainpolicy", "dp_col_type", "type")
 	</section>
 	</section>
 
 
 
 
-	<section>
+	<section id="dompolicy.p.col_att">
 		<title><varname>dp_col_att</varname> (string)</title>
 		<title><varname>dp_col_att</varname> (string)</title>
 		<para>
 		<para>
 		Name of column containing the AVP's name. If the rule stored in this
 		Name of column containing the AVP's name. If the rule stored in this
@@ -133,7 +133,7 @@ modparam("domainpolicy", "dp_col_att", "attribute")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="dompolicy.p.col_val">
 		<title><varname>dp_col_val</varname> (string)</title>
 		<title><varname>dp_col_val</varname> (string)</title>
 		<para>
 		<para>
 		Name of column containing the value for AVPs created by dp_can_connect().
 		Name of column containing the value for AVPs created by dp_can_connect().
@@ -148,11 +148,11 @@ modparam("domainpolicy", "dp_col_val", "values")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="dompolicy.p.port_override_avp">
 		<title><varname>port_override_avp</varname> (string)</title>
 		<title><varname>port_override_avp</varname> (string)</title>
 		<para>
 		<para>
 		This parameter defines the name of the AVP where dp_apply_policy() will look
 		This parameter defines the name of the AVP where dp_apply_policy() will look
-		for an override port number. 
+		for an override port number.
 		</para>
 		</para>
 		<para>
 		<para>
 		Default value is <quote>portoverride</quote>.
 		Default value is <quote>portoverride</quote>.
@@ -165,10 +165,10 @@ modparam("domainpolicy", "port_override_avp", "portoverride")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="dompolicy.p.transport_override_avp">
 		<title><varname>transport_override_avp</varname> (string)</title>
 		<title><varname>transport_override_avp</varname> (string)</title>
 		<para>
 		<para>
-		Name of the AVP which contains the override transport setting. 
+		Name of the AVP which contains the override transport setting.
 		</para>
 		</para>
 		<para>
 		<para>
 		Default value is <quote>transportoverride</quote>.
 		Default value is <quote>transportoverride</quote>.
@@ -185,7 +185,7 @@ modparam("domainpolicy", "transport_override_avp", "transportoverride")
 	<section>
 	<section>
 		<title><varname>domain_replacement_avp</varname> (string)</title>
 		<title><varname>domain_replacement_avp</varname> (string)</title>
 		<para>
 		<para>
-		Name of the AVP which contains a domain replacement. 
+		Name of the AVP which contains a domain replacement.
 		</para>
 		</para>
 		<para>
 		<para>
 		Default value is <quote>domainreplacement</quote>.
 		Default value is <quote>domainreplacement</quote>.
@@ -202,7 +202,7 @@ modparam("domainpolicy", "domain_replacement_avp", "domainreplacement")
 	<section>
 	<section>
 		<title><varname>domain_prefix_avp</varname> (string)</title>
 		<title><varname>domain_prefix_avp</varname> (string)</title>
 		<para>
 		<para>
-		Name of the AVP which contains a domain prefix. 
+		Name of the AVP which contains a domain prefix.
 		</para>
 		</para>
 		<para>
 		<para>
 		Default value is <quote>domainprefix</quote>.
 		Default value is <quote>domainprefix</quote>.
@@ -219,7 +219,7 @@ modparam("domainpolicy", "domain_prefix_avp", "domainprefix")
 	<section>
 	<section>
 		<title><varname>domain_suffix_avp</varname> (string)</title>
 		<title><varname>domain_suffix_avp</varname> (string)</title>
 		<para>
 		<para>
-		Name of the AVP which contains a domain suffix. 
+		Name of the AVP which contains a domain suffix.
 		</para>
 		</para>
 		<para>
 		<para>
 		Default value is <quote>domainsuffix</quote>.
 		Default value is <quote>domainsuffix</quote>.
@@ -237,7 +237,7 @@ modparam("domainpolicy", "domain_suffix_avp", "domainsuffix")
 		<para>
 		<para>
 		Name of the AVP which contains a send_socket. The format of the
 		Name of the AVP which contains a send_socket. The format of the
 		send socket (the payload of this AVP) must be in the format
 		send socket (the payload of this AVP) must be in the format
-		[proto:]ip_address[:port]. The function dp_apply_policy will 
+		[proto:]ip_address[:port]. The function dp_apply_policy will
 		look for this AVP and if defined, it will force the send socket
 		look for this AVP and if defined, it will force the send socket
 		to its value (similar to the force_send_socket core function).
 		to its value (similar to the force_send_socket core function).
 		</para>
 		</para>
@@ -259,14 +259,14 @@ modparam("domainpolicy", "send_socket_avp", "sendsocket")
 
 
 	<section>
 	<section>
 	<title>Functions</title>
 	<title>Functions</title>
-	<section>
+	<section id="dompolicy.f.dp_can_connect">
 		<title><function moreinfo="none">dp_can_connect()</function></title>
 		<title><function moreinfo="none">dp_can_connect()</function></title>
 		<para>
 		<para>
-		Checks the interconnection policy of the caller. It uses the domain in the 
-		request URI to perform the DP-DDDS algorithm according to draft-lendl-domain-policy-ddds-02 
-		to retrieve the domain's policy announcements. 
+		Checks the interconnection policy of the caller. It uses the domain in the
+		request URI to perform the DP-DDDS algorithm according to draft-lendl-domain-policy-ddds-02
+		to retrieve the domain's policy announcements.
 		As of this version, only records conforming to draft-lendl-speermint-federations-02
 		As of this version, only records conforming to draft-lendl-speermint-federations-02
-		and draft-lendl-speermint-technical-policy-00 are supported. 
+		and draft-lendl-speermint-technical-policy-00 are supported.
 		</para>
 		</para>
 		<para>
 		<para>
 		Non-terminal NAPTR records will cause recursion to the replacement domain. dp_can_connect()
 		Non-terminal NAPTR records will cause recursion to the replacement domain. dp_can_connect()
@@ -276,14 +276,14 @@ modparam("domainpolicy", "send_socket_avp", "sendsocket")
 		</para>
 		</para>
 		<para>
 		<para>
 		In order to simplify direct domain-based peerings all destination domains are
 		In order to simplify direct domain-based peerings all destination domains are
-		treated as if they contain a top priority "D2P+SIP:dom" rule with the domain itself as the 
+		treated as if they contain a top priority "D2P+SIP:dom" rule with the domain itself as the
 		value of the rule. Thus any database row with type = 'dom' and rule = 'example.com'
 		value of the rule. Thus any database row with type = 'dom' and rule = 'example.com'
 		will override any dynamic DNS-discovered rules.
 		will override any dynamic DNS-discovered rules.
 		</para>
 		</para>
 		<para>
 		<para>
-		For NAPTRs with service-type "D2P+SIP:fed", the federation IDs 
+		For NAPTRs with service-type "D2P+SIP:fed", the federation IDs
 		(as extracted from the regexp field) are used to retrieve
 		(as extracted from the regexp field) are used to retrieve
-		policy records from a local local database (basically: "SELECT dp_col_att, dp_col_val FROM 
+		policy records from a local local database (basically: "SELECT dp_col_att, dp_col_val FROM
 		dp_table WHERE dp_col_rule = '[federationID]' AND type = 'fed'). If records are found (and all other
 		dp_table WHERE dp_col_rule = '[federationID]' AND type = 'fed'). If records are found (and all other
 		records with the same order value are fulfillable) then AVPs will be created from
 		records with the same order value are fulfillable) then AVPs will be created from
 		the dp_col_att and dp_col_val columns.
 		the dp_col_att and dp_col_val columns.
@@ -297,8 +297,8 @@ modparam("domainpolicy", "send_socket_avp", "sendsocket")
 		"order" match and try to set the same AVP, then the behaviour is undefined.
 		"order" match and try to set the same AVP, then the behaviour is undefined.
 		</para>
 		</para>
 		<para>
 		<para>
-		The dp_col_att column specifies the AVP's name. If the AVP start with "s:" or "i:", the 
-		corresponding AVP type (string named or integer named) will be generated. If the excat specifier 
+		The dp_col_att column specifies the AVP's name. If the AVP start with "s:" or "i:", the
+		corresponding AVP type (string named or integer named) will be generated. If the excat specifier
 		is omited, the AVP type will be guessed.
 		is omited, the AVP type will be guessed.
 		</para>
 		</para>
 		<para>
 		<para>
@@ -363,7 +363,7 @@ switch(retcode) {
 		</programlisting>
 		</programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="dompolicy.f.dp_apply_policy">
 		<title><function moreinfo="none">dp_apply_policy()</function></title>
 		<title><function moreinfo="none">dp_apply_policy()</function></title>
 		<para>
 		<para>
 		This function sets the destination URI according to the policy returned
 		This function sets the destination URI according to the policy returned
@@ -373,7 +373,7 @@ switch(retcode) {
 		The AVPs can be configured in the module's parameter section.
 		The AVPs can be configured in the module's parameter section.
 		</para>
 		</para>
 		<para>
 		<para>
-		Note: The name of the AVPs must correspond with the names in the 
+		Note: The name of the AVPs must correspond with the names in the
 		<emphasis>att</emphasis> column in the domainpolicy table.
 		<emphasis>att</emphasis> column in the domainpolicy table.
 		</para>
 		</para>
 		<para>
 		<para>
@@ -384,7 +384,7 @@ switch(retcode) {
 		<listitem>
 		<listitem>
 		<para>
 		<para>
 			<emphasis>port_override_avp</emphasis>: If this AVP is set, the port
 			<emphasis>port_override_avp</emphasis>: If this AVP is set, the port
-			in the destination URI is set to this port. 
+			in the destination URI is set to this port.
 			Setting an override port disables NAPTR and
 			Setting an override port disables NAPTR and
 			SRV lookups according to RFC 3263.
 			SRV lookups according to RFC 3263.
 		</para>
 		</para>
@@ -394,14 +394,14 @@ switch(retcode) {
 			<emphasis>transport_override_avp</emphasis>: If this AVP is set, the transport
 			<emphasis>transport_override_avp</emphasis>: If this AVP is set, the transport
 			parameter in the destination URI is set to the specified transport ("udp", "tcp",
 			parameter in the destination URI is set to the specified transport ("udp", "tcp",
 			"tls").
 			"tls").
-			Setting an override transport also disables NAPTR lookups, but retains 
+			Setting an override transport also disables NAPTR lookups, but retains
 			an SRV lookup according to RFC 3263.
 			an SRV lookup according to RFC 3263.
 		</para>
 		</para>
 		</listitem>
 		</listitem>
 		<listitem>
 		<listitem>
 		<para>
 		<para>
 			<emphasis>domain_replacement_avp</emphasis>: If this AVP is set, the domain
 			<emphasis>domain_replacement_avp</emphasis>: If this AVP is set, the domain
-			in the destination URI will be replaced by this domain. 
+			in the destination URI will be replaced by this domain.
 		</para>
 		</para>
 		<para>
 		<para>
 			A non-terminal NAPTR and thus a referral to a new domain implicitly
 			A non-terminal NAPTR and thus a referral to a new domain implicitly
@@ -411,9 +411,9 @@ switch(retcode) {
 		<listitem>
 		<listitem>
 		<para>
 		<para>
 			<emphasis>domain_prefix_avp</emphasis>: If this AVP is set, the domain
 			<emphasis>domain_prefix_avp</emphasis>: If this AVP is set, the domain
-			in the destination URI will be prefixed with this "subdomain".  
-			E.g. if the domain in the request URI is 
-			"example.com" and the domain_prefix_avp contains "inbound", the domain 
+			in the destination URI will be prefixed with this "subdomain".
+			E.g. if the domain in the request URI is
+			"example.com" and the domain_prefix_avp contains "inbound", the domain
 			in the destinaton URI is set to "inbound.example.com".
 			in the destinaton URI is set to "inbound.example.com".
 		</para>
 		</para>
 		</listitem>
 		</listitem>
@@ -421,15 +421,15 @@ switch(retcode) {
 		<para>
 		<para>
 			<emphasis>domain_suffix_avp</emphasis>: If this AVP is set, the domain
 			<emphasis>domain_suffix_avp</emphasis>: If this AVP is set, the domain
 			in the destination URI will have the content of the AVP appended to it.
 			in the destination URI will have the content of the AVP appended to it.
-			E.g. if the domain in the request URI is 
-			"example.com" and the domain_suffix_avp contains "myroot.com", the domain 
+			E.g. if the domain in the request URI is
+			"example.com" and the domain_suffix_avp contains "myroot.com", the domain
 			in the destination URI is set to "example.com.myroot.com".
 			in the destination URI is set to "example.com.myroot.com".
 		</para>
 		</para>
 		</listitem>
 		</listitem>
 		<listitem>
 		<listitem>
 		<para>
 		<para>
 			<emphasis>send_socket_avp</emphasis>: If this AVP is set, the sending socket
 			<emphasis>send_socket_avp</emphasis>: If this AVP is set, the sending socket
-			will be forced to the socket in the AVP. The payload format of this AVP must 
+			will be forced to the socket in the AVP. The payload format of this AVP must
 			be [proto:]ip_address[:port].
 			be [proto:]ip_address[:port].
 		</para>
 		</para>
 		</listitem>
 		</listitem>
@@ -456,12 +456,6 @@ if (dp_apply_policy()) {
 	</section>
 	</section>
 	</section>
 	</section>
 
 
-	<section>
-	<title>RPC Commands</title>
-	<para>
-	</para>
-	</section>
-
 	<section>
 	<section>
 	<title>Usage Scenarios</title>
 	<title>Usage Scenarios</title>
 	<para>
 	<para>