Browse Source

cdp Documentation updates

Read my lips: It's configuration, not confiuaragion or confirtuaration... :-)
Olle E. Johansson 12 năm trước cách đây
mục cha
commit
a59b5bc19b
3 tập tin đã thay đổi với 37 bổ sung37 xóa
  1. 29 29
      modules/cdp/README
  2. 1 1
      modules/cdp/doc/cdp.xml
  3. 7 7
      modules/cdp/doc/cdp_admin.xml

+ 29 - 29
modules/cdp/README

@@ -1,4 +1,4 @@
-cdp Module
+The CDP Module
 
 Dragos Vingarzan
 
@@ -12,9 +12,9 @@ Edited by
 
 Richard Good
 
-   Copyright © 2006 FhG Fokus
+   Copyright © 2006 FhG Fokus
 
-   Copyright © 2012 Smile Communications
+   Copyright © 2012 Smile Communications
      __________________________________________________________________
 
    Table of Contents
@@ -150,9 +150,9 @@ Chapter 1. Admin Guide
 1. Overview
 
    CDP (C Diameter Peer) allows Diameter communication to and from
-   sip-router/kamailio. Most of the code is inherited from DISC
+   Kamailio. Most of the code is inherited from DISC
    http://developer.berlios.de/projects/disc/ and OpenIMS and modified for
-   use within Kamailio. A few improvements/new functionality has been
+   use within Kamailio. A few improvements and new functionality has been
    added along the way, for example, threshold reporting on Diameter calls
    that are serviced above a certain threshold.
 
@@ -169,14 +169,14 @@ Chapter 1. Admin Guide
    configuration file. The exported API can be seen in mod.c. The Full
    Diameter API is in diameter.h and diameter_api.h. IMS-specific
    constants can be found in diameter_ims.h. The protocol coding is
-   implemented in diameter_avp.c and diameter_msg.c. Diameter state
+   implemented in diameter_avp.c and diameter_msg.c. The diameter state
    machine is implemented in peerstatemachine.c - there is one of these
    for each peer which maintains all protocol/application state for each
    peer. peermanager.c is responsible for peer administration. Diameter
    transactions are implemented in transaction.c.
 
    There are 2 configuration areas for CDP. Firstly it must be loaded and
-   conifugred in the Kamailio.cfg file (this is the normal task associated
+   configured in the Kamailio.cfg file (this is the normal task associated
    with Kamailio modules). Then, an XML file is required to configure
    various Diameter parameters and all related peers and the associated
    routes.
@@ -206,7 +206,7 @@ Chapter 1. Admin Guide
 
    This is the location of the XML configuration file.
 
-   Default value is “DiameterPeer.xml�.
+   Default value is "DiameterPeer.xml".
 
    Example 1.1. Set config_file parameter
 ...
@@ -218,7 +218,7 @@ modparam("cdp", "config_file", "/etc/kamailio/diametercfg.xml")
    The time in ms above which a log error is wrtten to log file for long
    CDP transactions.
 
-   Default value is “500�.
+   Default value is "500".
 
    Example 1.2. Set latency_threshold parameter
 ...
@@ -229,7 +229,7 @@ modparam("cdp", "latency_threshold", 1000)
 
    5.1.
 
-   No functions available from configuraion. See API for internal
+   No functions available from configuration. See API for internal
    functions.
 
 6. Configuration Examples
@@ -240,7 +240,7 @@ modparam("cdp", "latency_threshold", 1000)
 6.1. DiameterPeer.xml example
 
    This is an example CDP configuration file. The location of this file is
-   confiured as a CDP parameter (config_file) - See section 4.1 Above
+   configured as a CDP parameter (config_file) - See section 4.1 Above
 
    Example 1.3. DiameterPeer.xml example
 <?xml version="1.0" encoding="UTF-8"?>
@@ -310,7 +310,7 @@ easure meant to
 or each peer found in here
                 a dedicated receiver process will be forked. All other unkwnown
 peers will share a single
-                receiver. NB. you must have a peer definition for each peer list
+                receiver. NB: You must have a peer definition for each peer list
 ed in the realm routing section
         -->
         <Peer FQDN="pcrf1.ims.smilecoms.com" Realm="ims.smilecoms.com" port="386
@@ -815,31 +815,31 @@ Chapter 3. Frequently Asked Questions
 
    3.1.
 
-       Where can I find more about Kamailio?
+   Where can I find more about Kamailio?
 
-       Take a look at http://www.kamailio.org/.
+   Take a look at http://www.kamailio.org/.
 
    3.2.
 
-       Where can I post a question about this module?
+   Where can I post a question about this module?
 
-       First at all check if your question was already answered on one of our
-       mailing lists:
-         * User Mailing List -
-           http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users
-         * Developer Mailing List -
-           http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
+   First at all check if your question was already answered on one of our
+   mailing lists:
+     * User Mailing List -
+       http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users
+     * Developer Mailing List -
+       http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
 
-       E-mails regarding any stable Kamailio release should be sent to
-       <[email protected]> and e-mails regarding development
-       versions should be sent to <[email protected]>.
+   E-mails regarding any stable Kamailio release should be sent to
+   <[email protected]> and e-mails regarding development
+   versions should be sent to <[email protected]>.
 
-       If you want to keep the mail private, send it to
-       <[email protected]>.
+   If you want to keep the mail private, send it to
+   <[email protected]>.
 
    3.3.
 
-       How can I report a bug?
+   How can I report a bug?
 
-       Please follow the guidelines provided at:
-       http://sip-router.org/tracker.
+   Please follow the guidelines provided at:
+   http://sip-router.org/tracker.

+ 1 - 1
modules/cdp/doc/cdp.xml

@@ -10,7 +10,7 @@
 
 <book xmlns:xi="http://www.w3.org/2001/XInclude">
 	<bookinfo>
-	<title>cdp Module</title>
+	<title>The CDP Module</title>
 	<productname class="trade">&kamailioname;</productname>
 	<authorgroup>
 		<author>

+ 7 - 7
modules/cdp/doc/cdp_admin.xml

@@ -13,9 +13,9 @@
     <title>Overview</title>
 
     <para>CDP (C Diameter Peer) allows Diameter communication to and from
-    sip-router/kamailio. Most of the code is inherited from DISC
+    Kamailio. Most of the code is inherited from DISC
     http://developer.berlios.de/projects/disc/ and OpenIMS and modified for
-    use within Kamailio. A few improvements/new functionality has been added
+    use within Kamailio. A few improvements and new functionality has been added
     along the way, for example, threshold reporting on Diameter calls that are
     serviced above a certain threshold.</para>
   </section>
@@ -49,14 +49,14 @@
     file. The exported API can be seen in mod.c. The Full Diameter API is in
     diameter.h and diameter_api.h. IMS-specific constants can be found in
     diameter_ims.h. The protocol coding is implemented in diameter_avp.c and
-    diameter_msg.c. Diameter state machine is implemented in
+    diameter_msg.c. The diameter state machine is implemented in
     peerstatemachine.c - there is one of these for each peer which maintains
     all protocol/application state for each peer. peermanager.c is responsible
     for peer administration. Diameter transactions are implemented in
     transaction.c.</para>
 
     <para>There are 2 configuration areas for CDP. Firstly it must be loaded
-    and conifugred in the Kamailio.cfg file (this is the normal task
+    and configured in the Kamailio.cfg file (this is the normal task
     associated with Kamailio modules). Then, an XML file is required to
     configure various Diameter parameters and all related peers and the
     associated routes.</para>
@@ -132,7 +132,7 @@ modparam("cdp", "latency_threshold", 1000)
     <title>Functions</title>
 
     <section>
-      <para>No functions available from configuraion. See API for internal
+      <para>No functions available from configuration. See API for internal
       functions.</para>
     </section>
   </section>
@@ -144,7 +144,7 @@ modparam("cdp", "latency_threshold", 1000)
       <title>DiameterPeer.xml example</title>
 
       <para>This is an example CDP configuration file. The location of this
-      file is confiured as a CDP parameter (config_file) - See section 4.1
+      file is configured as a CDP parameter (config_file) - See section 4.1
       Above</para>
 
       <example>
@@ -203,7 +203,7 @@ modparam("cdp", "latency_threshold", 1000)
         &lt;!--
                 Definition of peers to connect to and accept connections from. For each peer found in here
                 a dedicated receiver process will be forked. All other unkwnown peers will share a single
-                receiver. NB. you must have a peer definition for each peer listed in the realm routing section
+                receiver. NB: You must have a peer definition for each peer listed in the realm routing section
         --&gt;
         &lt;Peer FQDN="pcrf1.ims.smilecoms.com" Realm="ims.smilecoms.com" port="3868"/&gt;
         &lt;Peer FQDN="pcrf2.ims.smilecoms.com" Realm="ims.smilecoms.com" port="3868"/&gt;