[sr-dev] git:master: diversion minor doc updates, adding section ID's

[Olle E. Johansson]

Module: sip-router
Branch: master
Commit: 5236f6e6623057e959ef79ff7f1f61cfa2dbb096
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=5236f6e6623057e959ef79ff7f1f61cfa2dbb096

Author: Olle E. Johansson <oej at edvina.net>
Committer: Olle E. Johansson <oej at edvina.net>
Date:   Sun Oct  5 19:25:07 2014 +0200

diversion minor doc updates, adding section ID's

---

 modules/diversion/README                  |   20 ++++++++++----------
 modules/diversion/doc/diversion_admin.xml |   18 ++++++++----------
 modules/diversion/doc/diversion_devel.xml |    6 +++---
 3 files changed, 21 insertions(+), 23 deletions(-)

diff --git a/modules/diversion/README b/modules/diversion/README
index ff9d75d..c4c5a85 100644
--- a/modules/diversion/README
+++ b/modules/diversion/README
@@ -60,15 +60,15 @@ Chapter 1. Admin Guide
 
 1. Overview
 
-   The module implements the Diversion extensions as per
-   draft-levy-sip-diversion-08. The diversion extensions are useful in
-   various scenarios involving call forwarding. Typically one needs to
-   communicate the original recipient of the call to the PSTN gateway and
-   this is what the diversion extensions can be used for.
+   The module implements the Diversion extensions as per RFC 5806. The
+   diversion extensions are useful in various scenarios involving call
+   forwarding. Typically one needs to communicate the original recipient
+   of the call to the PSTN gateway and this is what the diversion
+   extensions can be used for.
 
 Warning
 
-   The draft-levy-sip-diversion-08 is expired!! See IETF I-D tracker.
+   Note that RFC 5806 has historic status.
 
 2. Dependencies
 
@@ -158,12 +158,12 @@ Content-Length: 0
 
 Chapter 2. Developer Guide
 
-   According to the specification new Diversion header field should be
+   According to the specification a new "Diversion" header field should be
    inserted as the topmost Diversion header field in the message, that
    means before any other existing Diversion header field in the message.
-   In addition to that, add_diversion function can be called several times
-   and each time it should insert the new Diversion header field as the
-   topmost one.
+   In addition to that, the add_diversion function can be called several
+   times and each time it should insert the new Diversion header field as
+   the topmost one.
 
    In order to implement this, add_diversion function creates the anchor
    in data_lump lists as a static variable to ensure that the next call of
diff --git a/modules/diversion/doc/diversion_admin.xml b/modules/diversion/doc/diversion_admin.xml
index 81cb428..4650ccc 100644
--- a/modules/diversion/doc/diversion_admin.xml
+++ b/modules/diversion/doc/diversion_admin.xml
@@ -13,19 +13,17 @@
 	
 	<title>&adminguide;</title>
 	
-	<section>
+	<section id="diversion.overview">
 	<title>Overview</title>
 	<para>
 		The module implements the Diversion extensions as per 
-		draft-levy-sip-diversion-08.  The
-		diversion extensions are useful in various scenarios involving call
-		forwarding. Typically one needs to communicate the original recipient 
-		of the call to the PSTN gateway and this is what the diversion 
-		extensions can be used for.
+		RFC 5806. The diversion extensions are useful in various
+		scenarios involving call forwarding. Typically one needs to communicate
+		the original recipient of the call to the PSTN gateway and this is what
+		the diversion extensions can be used for.
 	</para>
 	<warning><para>
-		The draft-levy-sip-diversion-08 is expired!! See
-		<ulink url="https://datatracker.ietf.org/public/idindex.cgi?command=id_detail&and;id=6002"> IETF I-D tracker</ulink>.
+		Note that RFC 5806 has historic status.
 	</para></warning>
 	</section>
 
@@ -52,7 +50,7 @@
 	</section>
 	<section>
 	<title>Parameters</title>
-	<section>
+	<section id="diversion.p.suffix">
 		<title><varname>suffix</varname> (string)</title>
 		<para>
 		The suffix to be appended to the end of the header field. You can use 
@@ -72,7 +70,7 @@ modparam("diversion", "suffix", ";privacy=full")
 	</section>
 	<section>
 	<title>Functions</title>
-	<section>
+	<section id="diversion.f.add_diversion">
 		<title><function moreinfo="none">add_diversion(reason [, uri])</function></title>
 		<para>
 		The function adds a new diversion header field before any other 
diff --git a/modules/diversion/doc/diversion_devel.xml b/modules/diversion/doc/diversion_devel.xml
index 0a39585..739555d 100644
--- a/modules/diversion/doc/diversion_devel.xml
+++ b/modules/diversion/doc/diversion_devel.xml
@@ -13,9 +13,9 @@
     
     <title>&develguide;</title>
     <para>
-	According to the specification new Diversion header field should be inserted as the topmost
-	Diversion header field in the message, that means before any other existing Diversion header
-	field in the message. In addition to that, <function
+	According to the specification a new <quote>Diversion</quote> header field should be inserted
+	as the topmost Diversion header field in the message, that means before any other existing
+	Diversion header field in the message. In addition to that, the <function
 	moreinfo="none">add_diversion</function> function can be called several times and each time
 	it should insert the new Diversion header field as the topmost one.
     </para>