소스 검색

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

Henning Westerholt 14 년 전
부모
커밋
288a80235f
2개의 변경된 파일17개의 추가작업 그리고 13개의 파일을 삭제
  1. 10 8
      modules_k/alias_db/README
  2. 7 5
      modules_k/alias_db/doc/alias_db_admin.xml

+ 10 - 8
modules_k/alias_db/README

@@ -83,15 +83,17 @@ Chapter 1. Admin Guide
 
 
 1. Overview
 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
    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
 2. Dependencies
 
 

+ 7 - 5
modules_k/alias_db/doc/alias_db_admin.xml

@@ -17,14 +17,16 @@
 	<section>
 	<section>
 	<title>Overview</title>
 	<title>Overview</title>
 	<para>
 	<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
 	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>
 	<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
 	penalty can be lowered. Also, the search can be performed on different
 	tables in the same script.
 	tables in the same script.
 	</para>
 	</para>