git:master: xhttp_rpc Fix typo and minor formatting in README - sr-dev

6 Feb 2013

Module: sip-router
Branch: master
Commit: 1d6b2ce07c6b661ed3e3a1c31b8ec408d68ed4e9
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=1d6b2ce0...
Author: Olle E. Johansson oej@edvina.net
Committer: Olle E. Johansson oej@edvina.net
Date:   Wed Feb  6 20:42:50 2013 +0100
xhttp_rpc Fix typo and minor formatting in README
---
modules/xhttp_rpc/README                  |   35 ++++++++++++++---------------
 modules/xhttp_rpc/doc/xhttp_rpc_admin.xml |   18 ++++++++++----
 2 files changed, 30 insertions(+), 23 deletions(-)

diff --git a/modules/xhttp_rpc/README b/modules/xhttp_rpc/README
index 46fb5d4..9796bc3 100644
--- a/modules/xhttp_rpc/README
+++ b/modules/xhttp_rpc/README
@@ -81,19 +81,18 @@ Chapter 1. Admin Guide
1.1. Limitations
-   This module does not implement asynchronous RPC commands. It is
-   unlikely that asynchronous RPC commands will be executed from an RPC
-   web interface.
-
-   This module does not accept parameters embedded in a structure (see RPC
-   documentation for more info about how parameters can be passed to RPC).
-
-   At startup, all RPC commands are sorted and grouped based on their
-   format. The expected format is [group].[subcommand]. The initial
-   xhttp_rpc webpage displays all the retrieved groups. All RPC commands
-   are available as sub-menus of each [group]. If an RPC command is not in
-   the expected format, it will be dropped from the initial xhttp_rpc home
-   page menu.
+     * This module does not implement asynchronous RPC commands. It is
+       unlikely that asynchronous RPC commands will be executed from an
+       RPC web interface.
+     * This module does not accept parameters embedded in a structure (see
+       RPC documentation for more info about how parameters can be passed
+       to RPC).
+     * At startup, all RPC commands are sorted and grouped based on their
+       format. The expected format is [group].[subcommand]. The initial
+       xhttp_rpc webpage displays all the retrieved groups. All RPC
+       commands are available as sub-menus of each [group]. If an RPC
+       command is not in the expected format, it will be dropped from the
+       initial xhttp_rpc home page menu.
2. Dependencies
@@ -118,8 +117,8 @@ Chapter 1. Admin Guide
3.1. xhttp_rpc_root (str)
-   It specifies the root path for RPC http requests. The link to the RPC
-   web interface must be constructed using the following patern:
+   Specifies the root path for RPC http requests. The link to the RPC web
+   interface must be constructed using the following pattern:
    http://%5Bserver_IP%5D:%5Btcp_port%5D/%5Bxhttp_rpc_root]
Default value is "rpc".
@@ -131,8 +130,8 @@ modparam("xhttp_rpc", "xhttp_rpc_root", "http_rpc")
3.2. xhttp_rpc_buf_size (str)
-   It specifies the maximum length of the buffer used to write in the RPC
-   reply information in order to build the HTML response.
+   Specifies the maximum length of the buffer used to write the RPC reply
+   information in order to build the HTML response.
Default value is 0 (auto set to 1/3 of the size of the configured pkg
    mem).
@@ -146,7 +145,7 @@ modparam("xhttp", "xhttp_rpc_buf_size", )
4.1. dispatch_xhttp_rpc()
-4.1. dispatch_xhttp_rpc()
+4.1.  dispatch_xhttp_rpc()
Handle the HTTP request and generate a response.
diff --git a/modules/xhttp_rpc/doc/xhttp_rpc_admin.xml b/modules/xhttp_rpc/doc/xhttp_rpc_admin.xml
index b5f8974..3b658e9 100644
--- a/modules/xhttp_rpc/doc/xhttp_rpc_admin.xml
+++ b/modules/xhttp_rpc/doc/xhttp_rpc_admin.xml
@@ -26,24 +26,32 @@
<section>
    <title>Limitations</title>
+	<itemizedlist>
+	<listitem>
    <para>
    	This module does not implement asynchronous RPC commands.
    	It is unlikely that asynchronous RPC commands will be executed
    	from an RPC web interface.
    </para>
+	</listitem>
+	<listitem>
    <para>
    	This module does not accept parameters embedded in a structure
    	(see RPC documentation for more info about how parameters can be
    	passed to RPC).
    </para>
+	</listitem>
+	<listitem>
    <para>
    	At startup, all RPC commands are sorted and grouped based on
-		their format.  The expected format is [group].[subcommand].
+		their format. The expected format is [group].[subcommand].
    	The initial xhttp_rpc webpage displays all the retrieved groups.
    	All RPC commands are available as sub-menus of each [group].
    	If an RPC command is not in the expected format, it will be
    	dropped from the initial xhttp_rpc home page menu.
    </para>
+	</listitem>
+	</itemizedlist>
    </section>
    </section>
@@ -82,9 +90,9 @@
    <section>
    	<title><varname>xhttp_rpc_root</varname> (str)</title>
    	<para>
-			It specifies the root path for RPC http requests.
+			Specifies the root path for RPC http requests.
    		The link to the RPC web interface must be constructed
-			using the following patern:
+			using the following pattern:
    		http://%5Bserver_IP%5D:%5Btcp_port%5D/%5Bxhttp_rpc_root] 
    	</para>
    	<para>
@@ -104,8 +112,8 @@ modparam("xhttp_rpc", "xhttp_rpc_root", "http_rpc")
    <section>
    	<title><varname>xhttp_rpc_buf_size</varname> (str)</title>
    	<para>
-			It specifies the maximum length of the buffer used
-			to write in the RPC reply information in order to
+			Specifies the maximum length of the buffer used
+			to write the RPC reply information in order to
    		build the HTML response.
    	</para>
    	<para>

    