[sr-dev] git:master: uuid Minor doc updates

Olle E. Johansson oej at edvina.net
Tue Sep 23 21:58:01 CEST 2014


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

Author: Olle E. Johansson <oej at edvina.net>
Committer: Olle E. Johansson <oej at edvina.net>
Date:   Tue Sep 23 21:57:44 2014 +0200

uuid Minor doc updates

---

 modules/uuid/README             |    7 +++++--
 modules/uuid/doc/uuid_admin.xml |    7 +++++--
 2 files changed, 10 insertions(+), 4 deletions(-)

diff --git a/modules/uuid/README b/modules/uuid/README
index 2b1ce31..1be3f53 100644
--- a/modules/uuid/README
+++ b/modules/uuid/README
@@ -44,7 +44,10 @@ Chapter 1. Admin Guide
 1. Overview
 
    This module exports the $uuid(type) class of variables that return
-   unique values using libuuid functions.
+   unique values using functions from the libuuid library. UUIDs are used
+   in the +sip.instance media feature tag in SIP, but can also be used for
+   other purposes, like defining a unique session ID for a group of SIP
+   dialogs.
 
 2. Dependencies
 
@@ -64,7 +67,7 @@ Chapter 1. Admin Guide
 
 3. Usage
 
-   Following variables can be used:
+   The following variables can be used:
      * $uuid(g) - return the UUID value using uuid_generate().
      * $uuid(r) - return the UUID value using uuid_generate_random().
      * $uuid(t) - return the UUID value using uuid_generate_time().
diff --git a/modules/uuid/doc/uuid_admin.xml b/modules/uuid/doc/uuid_admin.xml
index 902d006..5cc0649 100644
--- a/modules/uuid/doc/uuid_admin.xml
+++ b/modules/uuid/doc/uuid_admin.xml
@@ -17,7 +17,10 @@
 	<title>Overview</title>
 	<para>
 		This module exports the $uuid(type) class of variables that return
-		unique values using libuuid functions.
+		unique values using functions from the libuuid library. UUIDs are
+		used in the +sip.instance media feature tag in SIP, but can also
+		be used for other purposes, like defining a unique session ID for a
+		group of SIP dialogs.
 	</para>
 	</section>
 
@@ -55,7 +58,7 @@
 	<section>
 		<title>Usage</title>
 		<para>
-			Following variables can be used:
+			The following variables can be used:
 			<itemizedlist>
 			<listitem>
 			<para>




More information about the sr-dev mailing list