[sr-dev] git:master: ipops Add section IDs to README xml files
Olle E. Johansson
oej at edvina.net
Sat Apr 6 14:59:43 CEST 2013
Module: sip-router
Branch: master
Commit: 0f4168e0e6b53c8993121f7a751cabecc2d3e1f3
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=0f4168e0e6b53c8993121f7a751cabecc2d3e1f3
Author: Olle E. Johansson <oej at edvina.net>
Committer: Olle E. Johansson <oej at edvina.net>
Date: Sat Apr 6 14:51:59 2013 +0200
ipops Add section IDs to README xml files
---
modules/ipops/README | 44 ++++++++++++++++++------------------
modules/ipops/doc/ipops_admin.xml | 22 +++++++++---------
2 files changed, 33 insertions(+), 33 deletions(-)
diff --git a/modules/ipops/README b/modules/ipops/README
index a0250a5..bd79553 100644
--- a/modules/ipops/README
+++ b/modules/ipops/README
@@ -76,8 +76,8 @@ Chapter 1. Admin Guide
1. Overview
- This module offers operations for handling IP addresses, both IPv4 and
- IPv6.
+ The IPops module offers operations for handling IP addresses, both IPv4
+ and IPv6.
IPv6 is defined in RFC 2460. The same IPv6 address can be represented
by different ASCII strings, so binary comparison is required. For
@@ -125,7 +125,7 @@ Chapter 1. Admin Guide
4.9. is_ip_rfc1918 (ip)
4.10. is_in_subnet (ip, subnet)
-4.1. is_ip (ip)
+4.1. is_ip (ip)
Returns TRUE if the argument is a valid IPv4, IPv6 or IPv6 reference.
FALSE otherwise.
@@ -137,14 +137,14 @@ Chapter 1. Admin Guide
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
- Example 1.1. is_ip usage
+ Example 1.1. is_ip usage
...
if (is_ip($rd)) {
xlog("L_INFO", "RURI domain is an IP address (not a host name/domain)\n");
}
...
-4.2. is_pure_ip (ip)
+4.2. is_pure_ip (ip)
Returns TRUE if the argument is a valid IPv4 or IPv6. FALSE otherwise.
@@ -154,7 +154,7 @@ if (is_ip($rd)) {
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
- Example 1.2. is_pure_ip usage
+ Example 1.2. is_pure_ip usage
...
$var(ip) = "::1";
if (is_pure_ip($var(ip))) {
@@ -162,7 +162,7 @@ if (is_pure_ip($var(ip))) {
}
...
-4.3. is_ipv4 (ip)
+4.3. is_ipv4 (ip)
Returns TRUE if the argument is a valid IPv4. FALSE otherwise.
@@ -172,14 +172,14 @@ if (is_pure_ip($var(ip))) {
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
- Example 1.3. is_ipv4 usage
+ Example 1.3. is_ipv4 usage
...
if (is_ipv4("1.2.3.4")) {
xlog("L_INFO", "it's IPv4\n");
}
...
-4.4. is_ipv6 (ip)
+4.4. is_ipv6 (ip)
Returns TRUE if the argument is a valid IPv6. FALSE otherwise.
@@ -189,14 +189,14 @@ if (is_ipv4("1.2.3.4")) {
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
- Example 1.4. is_ipv6 usage
+ Example 1.4. is_ipv6 usage
...
if (is_ipv6("1080:0:0:0:8:800:200C:417A")) {
xlog("L_INFO", "it's IPv6\n");
}
...
-4.5. is_ipv6_reference (ip)
+4.5. is_ipv6_reference (ip)
Returns TRUE if the argument is a valid IPv6 reference. FALSE
otherwise.
@@ -207,14 +207,14 @@ if (is_ipv6("1080:0:0:0:8:800:200C:417A")) {
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
- Example 1.5. is_ipv6_reference usage
+ Example 1.5. is_ipv6_reference usage
...
if (is_ipv6_reference("[1080:0:0:0:8:800:200C:417A]")) {
xlog("L_INFO", "it's IPv6 reference\n");
}
...
-4.6. ip_type (ip)
+4.6. ip_type (ip)
Returns the type of the given IP.
@@ -230,7 +230,7 @@ if (is_ipv6_reference("[1080:0:0:0:8:800:200C:417A]")) {
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
- Example 1.6. ip_type usage
+ Example 1.6. ip_type usage
...
ip_type($var(myip));
switch($rc) {
@@ -249,7 +249,7 @@ switch($rc) {
}
...
-4.7. compare_ips (ip1, ip2)
+4.7. compare_ips (ip1, ip2)
Returns TRUE if both IP addresses are the same. FALSE otherwise. This
function also allows comparing an IPv6 address against an IPv6
@@ -263,7 +263,7 @@ switch($rc) {
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
- Example 1.7. compare_ips usage
+ Example 1.7. compare_ips usage
...
if (compare_ips("1080:0000:0000:0000:0008:0800:200C:417A", "[1080::8:800:200C:41
7A]")) {
@@ -271,7 +271,7 @@ if (compare_ips("1080:0000:0000:0000:0008:0800:200C:417A", "[1080::8:800:200C:41
}
...
-4.8. compare_pure_ips (ip1, ip2)
+4.8. compare_pure_ips (ip1, ip2)
Returns TRUE if both IP's are the same. FALSE otherwise. This function
does NOT allow comparing an IPv6 against an IPv6 reference.
@@ -285,14 +285,14 @@ if (compare_ips("1080:0000:0000:0000:0008:0800:200C:417A", "[1080::8:800:200C:41
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
- Example 1.8. compare_pure_ips usage
+ Example 1.8. compare_pure_ips usage
...
if (compare_pure_ips($si, "1080::8:800:200C:417A")) {
xlog("L_INFO", "both are the same IP\n");
}
...
-4.9. is_ip_rfc1918 (ip)
+4.9. is_ip_rfc1918 (ip)
Returns TRUE if the argument is a private IPv4 according to RFC 1918.
FALSE otherwise.
@@ -303,14 +303,14 @@ if (compare_pure_ips($si, "1080::8:800:200C:417A")) {
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
- Example 1.9. is_ip_rfc1918 usage
+ Example 1.9. is_ip_rfc1918 usage
...
if (is_ip_rfc1918("10.0.123.123")) {
xlog("L_INFO", "it's a private IPv4\n");
}
...
-4.10. is_in_subnet (ip, subnet)
+4.10. is_in_subnet (ip, subnet)
Returns TRUE if the first argument is an IP address within the (CIDR
notation) subnet in the second argument. FALSE otherwise.
@@ -323,7 +323,7 @@ if (is_ip_rfc1918("10.0.123.123")) {
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
- Example 1.10. is_in_subnet usage
+ Example 1.10. is_in_subnet usage
...
if (is_in_subnet("10.0.123.123", "10.0.123.1/24")) {
xlog("L_INFO", "it's in the subnet\n");
diff --git a/modules/ipops/doc/ipops_admin.xml b/modules/ipops/doc/ipops_admin.xml
index 8cbeac2..c7ce810 100644
--- a/modules/ipops/doc/ipops_admin.xml
+++ b/modules/ipops/doc/ipops_admin.xml
@@ -19,7 +19,7 @@
<title>Overview</title>
<para>
- This module offers operations for handling IP addresses, both IPv4 and IPv6.
+ The IPops module offers operations for handling IP addresses, both IPv4 and IPv6.
</para>
<para>
IPv6 is defined in <ulink url="http://tools.ietf.org/html/rfc2460">RFC 2460</ulink>.
@@ -93,7 +93,7 @@
<title>Functions</title>
- <section>
+ <section id="ipops.f.is_ip">
<title>
<function moreinfo="none">is_ip (ip)</function>
</title>
@@ -131,7 +131,7 @@ if (is_ip($rd)) {
</section>
- <section>
+ <section id="ipops.f.is_pur_ip">
<title>
<function moreinfo="none">is_pure_ip (ip)</function>
</title>
@@ -170,7 +170,7 @@ if (is_pure_ip($var(ip))) {
</section>
- <section>
+ <section id="ipops.f.is_ipv4">
<title>
<function moreinfo="none">is_ipv4 (ip)</function>
</title>
@@ -208,7 +208,7 @@ if (is_ipv4("1.2.3.4")) {
</section>
- <section>
+ <section id="ipops.f.is_ipv6">
<title>
<function moreinfo="none">is_ipv6 (ip)</function>
</title>
@@ -246,7 +246,7 @@ if (is_ipv6("1080:0:0:0:8:800:200C:417A")) {
</section>
- <section>
+ <section id="ipops.f.is_ipv6_reference">
<title>
<function moreinfo="none">is_ipv6_reference (ip)</function>
</title>
@@ -284,7 +284,7 @@ if (is_ipv6_reference("[1080:0:0:0:8:800:200C:417A]")) {
</section>
- <section>
+ <section id="ipops.f.is_ip_type">
<title>
<function moreinfo="none">ip_type (ip)</function>
</title>
@@ -359,7 +359,7 @@ switch($rc) {
</section>
- <section>
+ <section id="ipops.f.compare_ips">
<title>
<function moreinfo="none">compare_ips (ip1, ip2)</function>
</title>
@@ -403,7 +403,7 @@ if (compare_ips("1080:0000:0000:0000:0008:0800:200C:417A", "[1080::8:800:200C:41
</section>
- <section>
+ <section id="ipops.f.compare_pure_ips">
<title>
<function moreinfo="none">compare_pure_ips (ip1, ip2)</function>
</title>
@@ -447,7 +447,7 @@ if (compare_pure_ips($si, "1080::8:800:200C:417A")) {
</section>
- <section>
+ <section id="ipops.f.is_ip_rfc1918">
<title>
<function moreinfo="none">is_ip_rfc1918 (ip)</function>
</title>
@@ -485,7 +485,7 @@ if (is_ip_rfc1918("10.0.123.123")) {
</section>
- <section>
+ <section id="ipops.f.is_in_subnet">
<title>
<function moreinfo="none">is_in_subnet (ip, subnet)</function>
</title>
More information about the sr-dev
mailing list