sl: README includes module parameters

modules/sl/README

@@ -12,11 +12,17 @@ Daniel-Constantin Mierla
      __________________________________________________________________
 
    1.1. Overview
-   1.2. Functions
+   1.2. Parameters
 
-        1.2.1. sl_send_reply(code, reason)
-        1.2.2. send_reply(code, reason)
-        1.2.3. sl_reply_error()
+        1.2.1. default_code (int)
+        1.2.2. default_reason (str)
+        1.2.3. bind_tm (int)
+
+   1.3. Functions
+
+        1.3.1. sl_send_reply(code, reason)
+        1.3.2. send_reply(code, reason)
+        1.3.3. sl_reply_error()
 
 1.1. Overview
 
@@ -44,9 +50,45 @@ Daniel-Constantin Mierla
    mirrored in ACK. SER will not see its signature and forward the ACK
    downstream. Caused harm is not bad--just a useless ACK is forwarded.
 
-1.2. Functions
+1.2. Parameters
+
+1.2.1. default_code (int)
+
+   Default reply status code.
+
+   Default value is 500.
+
+   Example 1. default_code example
+...
+modparam("sl", "default_code", 505)
+...
+
+1.2.2. default_reason (str)
+
+   Default reply reason phrase.
+
+   Default value is 'Internal Server Error'.
+
+   Example 2. default_reason example
+...
+modparam("sl", "default_reason", "Server Error")
+...
+
+1.2.3. bind_tm (int)
+
+   Controls if SL module should attempt to bind to TM module in order to
+   send stateful reply when the transaction is created.
+
+   Default value is 1 (enabled).
+
+   Example 3. bind_tm example
+...
+modparam("sl", "bind_tm", 0)  # feature disabled
+...
+
+1.3. Functions
 
-1.2.1.  sl_send_reply(code, reason)
+1.3.1.  sl_send_reply(code, reason)
 
    For the current request, a reply is sent back having the given code and
    text reason. The reply is sent stateless, totally independent of the
@@ -56,12 +98,12 @@ Daniel-Constantin Mierla
      * code - Return code.
      * reason - Reason phrase.
 
-   Example 1. sl_send_reply usage
+   Example 4. sl_send_reply usage
 ...
 sl_send_reply("404", "Not found");
 ...
 
-1.2.2.  send_reply(code, reason)
+1.3.2.  send_reply(code, reason)
 
    For the current request, a reply is sent back having the given code and
    text reason. The reply is sent stateful or stateless, depending of the
@@ -75,20 +117,20 @@ sl_send_reply("404", "Not found");
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE.
 
-   Example 2. send_reply usage
+   Example 5. send_reply usage
 ...
 send_reply("404", "Not found");
 ...
 send_reply("403", "Invalid user - $fU");
 ...
 
-1.2.3.  sl_reply_error()
+1.3.3.  sl_reply_error()
 
    Sends back an error reply describing the nature of the last internal
    error. Usually this function should be used after a script function
    that returned an error code.
 
-   Example 3. sl_reply_error usage
+   Example 6. sl_reply_error usage
 ...
 sl_reply_error();
 ...

modules/sl/doc/params.xml

@@ -17,7 +17,9 @@
 		<example>
 		<title>default_code example</title>
 		<programlisting format="linespecific">
+...
 modparam("sl", "default_code", 505)
+...
 </programlisting>
 		</example>
 	</section>
@@ -33,7 +35,9 @@ modparam("sl", "default_code", 505)
 		<example>
 		<title>default_reason example</title>
 		<programlisting format="linespecific">
+...
 modparam("sl", "default_reason", "Server Error")
+...
 </programlisting>
 		</example>
 	</section>
@@ -50,7 +54,9 @@ modparam("sl", "default_reason", "Server Error")
 		<example>
 		<title>bind_tm example</title>
 		<programlisting format="linespecific">
+...
 modparam("sl", "bind_tm", 0)  # feature disabled
+...
 </programlisting>
 		</example>
 	</section>

modules/sl/doc/sl.xml

@@ -66,6 +66,7 @@
 
     </section>
 
+    <xi:include href="params.xml"/>
     <xi:include href="functions.xml"/>
 
 </section>