[sr-dev] git:master: alias_db(k): rephrase documentation a bit to make it hopefully better understandable

[Henning Westerholt]

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

Author: Henning Westerholt <henning.westerholt at 1und1.de>
Committer: Henning Westerholt <henning.westerholt at 1und1.de>
Date:   Wed Jul 27 17:29:14 2011 +0200

alias_db(k): rephrase documentation a bit to make it hopefully better understandable

---

 modules_k/alias_db/README                 |   18 ++++++++++--------
 modules_k/alias_db/doc/alias_db_admin.xml |   12 +++++++-----
 2 files changed, 17 insertions(+), 13 deletions(-)

diff --git a/modules_k/alias_db/README b/modules_k/alias_db/README
index 8c18133..33743d4 100644
--- a/modules_k/alias_db/README
+++ b/modules_k/alias_db/README
@@ -83,15 +83,17 @@ Chapter 1. Admin Guide
 
 1. Overview
 
-   ALIAS_DB module can be used as an alternative for user aliases via
+   The ALIAS_DB module can be used as an alternative for user aliases via
    usrloc. The main feature is that it does not store all addiacent data
-   as for user location and always uses database for search (no memory
-   caching).
-
-   Having no memory caching the speed of search can decrease but the
-   provisioning is easier. With very fast databases like MySQL the speed
-   penalty can be lowered. Also, the search can be performed on different
-   tables in the same script.
+   as for user location and always uses the database for search (no memory
+   caching). A common use case is to provide additional user aliases, i.e.
+   to supplement the registration in the location database. Users are this
+   way on a proxy reachable with several request URIs.
+
+   As the module use no memory caching the lookup is a bit slower but the
+   data provisioning is easier. With very fast databases like MySQL the
+   speed penalty can be lowered. Also, the search can be performed on
+   different tables in the same script.
 
 2. Dependencies
 
diff --git a/modules_k/alias_db/doc/alias_db_admin.xml b/modules_k/alias_db/doc/alias_db_admin.xml
index 1e662b5..02b2913 100644
--- a/modules_k/alias_db/doc/alias_db_admin.xml
+++ b/modules_k/alias_db/doc/alias_db_admin.xml
@@ -17,14 +17,16 @@
 	<section>
 	<title>Overview</title>
 	<para>
-	ALIAS_DB module can be used as an alternative for user aliases
+	The ALIAS_DB module can be used as an alternative for user aliases
 	via usrloc. The main feature is that it does not store all addiacent
-	data as for user location and always uses database for search (no
-	memory caching).
+	data as for user location and always uses the database for search (no
+	memory caching). A common use case is to provide additional user
+	aliases, i.e. to supplement the registration in the location database.
+	Users are this way on a proxy reachable with several request URIs.
 	</para>
 	<para>
-	Having no memory caching the speed of search can decrease but the
-	provisioning is easier. With very fast databases like MySQL the speed
+	As the module use no memory caching the lookup is a bit slower but the
+	data provisioning is easier. With very fast databases like MySQL the speed
 	penalty can be lowered. Also, the search can be performed on different
 	tables in the same script.
 	</para>