[sr-dev] git:master: pipelimit: small reformating of parm presentation
Daniel-Constantin Mierla
miconda at gmail.com
Sat Oct 1 22:05:47 CEST 2011
Module: sip-router
Branch: master
Commit: bc995845e31a01563d4cec863f73f729fd84da46
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=bc995845e31a01563d4cec863f73f729fd84da46
Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: Sat Oct 1 10:59:52 2011 +0200
pipelimit: small reformating of parm presentation
- avoid syntax conflict between txt result and dokuwiki link when
generating indexes
---
modules/auth_identity/README | 16 ++++++------
modules/pipelimit/README | 36 ++++++++++++++--------------
modules/pipelimit/doc/pipelimit_admin.xml | 2 +-
3 files changed, 27 insertions(+), 27 deletions(-)
diff --git a/modules/auth_identity/README b/modules/auth_identity/README
index a1a078c..592f0aa 100644
--- a/modules/auth_identity/README
+++ b/modules/auth_identity/README
@@ -4,7 +4,7 @@ Gergely Kovacs
Iptel.org
- Copyright © 2007 Iptel.org
+ Copyright © 2007 Iptel.org
__________________________________________________________________
1.1. Overview
@@ -150,7 +150,7 @@ modparam("auth_identity","msg_timeout",600)
1.6. Authorizer service functions
-1.6.1. auth_date_proc()
+1.6.1. auth_date_proc()
If a message, the auth service should authorize, contains Date header
then this function checks whether it falls in message timeout (set by
@@ -163,7 +163,7 @@ modparam("auth_identity","msg_timeout",600)
No dependencies
-1.6.2. auth_add_identity()
+1.6.2. auth_add_identity()
Assembles digest-string from the message, calculates its SHA1 hash,
encrypts it with the private key (set by privatekey_path parameter) of
@@ -293,7 +293,7 @@ modparam("auth_identity","accept_pem_certs",1)
1.9. Verifier service functions
-1.9.1. vrfy_check_date()
+1.9.1. vrfy_check_date()
Checks Date header of the incoming message whether falls in validity
time (set by auth_validity_time parameter)
@@ -302,7 +302,7 @@ modparam("auth_identity","accept_pem_certs",1)
No dependencies
-1.9.2. vrfy_get_certificate()
+1.9.2. vrfy_get_certificate()
Tries to get certificate defined by the value of Identity-info header
from certificate table (which size is set by certificate_cache_limit
@@ -313,7 +313,7 @@ modparam("auth_identity","accept_pem_certs",1)
No dependencies
-1.9.3. vrfy_check_certificate()
+1.9.3. vrfy_check_certificate()
Checks whether the downloaded certificate is valid (is not expired, its
subject and the domain part of the URL are the same) and adds it to
@@ -323,7 +323,7 @@ modparam("auth_identity","accept_pem_certs",1)
vrfy_get_certificate() must be called before
-1.9.4. vrfy_check_msgvalidity()
+1.9.4. vrfy_check_msgvalidity()
Assembles digest-string from the message, create SHA1 hash and compares
it with the decrypted value of Identity header.
@@ -333,7 +333,7 @@ modparam("auth_identity","accept_pem_certs",1)
vrfy_get_certificate() must be called before and
vrfy_check_certificate() should be called before
-1.9.5. vrfy_check_callid()
+1.9.5. vrfy_check_callid()
Checks whether the current call's been already processed in validity
time (set by auth_validity_time) to recognize call replay attacks. If
diff --git a/modules/pipelimit/README b/modules/pipelimit/README
index d248c48..4205026 100644
--- a/modules/pipelimit/README
+++ b/modules/pipelimit/README
@@ -8,9 +8,9 @@ Edited by
Daniel-Constantin Mierla
- Copyright © 2010 Asipto.com
+ Copyright © 2010 Asipto.com
- Copyright © 2006 Freenet Cityline GmbH
+ Copyright © 2006 Freenet Cityline GmbH
__________________________________________________________________
Table of Contents
@@ -37,7 +37,7 @@ Daniel-Constantin Mierla
4. Exported Functions
4.1. pl_check(name)
- 4.2. pl_drop([[min ], max])
+ 4.2. pl_drop([ [min ], max ])
5. Exported MI Functions
@@ -87,7 +87,7 @@ Chapter 1. Admin Guide
4. Exported Functions
4.1. pl_check(name)
- 4.2. pl_drop([[min ], max])
+ 4.2. pl_drop([ [min ], max ])
5. Exported MI Functions
@@ -145,7 +145,7 @@ Chapter 1. Admin Guide
URL of the database server to be used.
- Default value is “mysql://openser:openserrw@localhost/openserâ€.
+ Default value is "mysql://openser:openserrw@localhost/openser".
Example 1.1. Set db_url parameter
...
@@ -156,7 +156,7 @@ modparam("pipelimit", "db_url", "dbdriver://username:password@dbhost/dbname")
Name of DB table where data definition for pipes is stores.
- Default value is “pl_pipesâ€.
+ Default value is "pl_pipes".
Example 1.2. Set plp_table_name parameter
...
@@ -167,7 +167,7 @@ modparam("pipelimit", "plp_table_name", "mypipes")
Name of 'pipeid' column.
- Default value is “pipeidâ€.
+ Default value is "pipeid".
Example 1.3. Set plp_pipeid_column parameter
...
@@ -178,7 +178,7 @@ modparam("pipelimit", "plp_pipeid_column", "name")
Name of 'limit' column.
- Default value is “limitâ€.
+ Default value is "limit".
Example 1.4. Set plp_limit_column parameter
...
@@ -189,7 +189,7 @@ modparam("pipelimit", "plp_limit_column", "name")
Name of 'algorithm' column.
- Default value is “algorithmâ€.
+ Default value is "algorithm".
Example 1.5. Set plp_algorithm_column parameter
...
@@ -247,9 +247,9 @@ sercmd cfg.set_now_string ratelimit reply_reason "Limiting"
4. Exported Functions
4.1. pl_check(name)
- 4.2. pl_drop([[min ], max])
+ 4.2. pl_drop([ [min ], max ])
-4.1. pl_check(name)
+4.1. pl_check(name)
Check the current request against the 'name' pipe. The pipe name can be
provided via a pseudo variabile.
@@ -278,7 +278,7 @@ sercmd cfg.set_now_string ratelimit reply_reason "Limiting"
}
...
-4.2. pl_drop([[min ], max])
+4.2. pl_drop([ [min ], max ])
For the current request, a "503 - Server Unavailable" reply is sent
back. The reply may or may not have a "Retry-After" header. If no
@@ -313,7 +313,7 @@ sercmd cfg.set_now_string ratelimit reply_reason "Limiting"
5.5. pl_get_pid
5.6. pl_push_load
-5.1. pl_stats
+5.1. pl_stats
Lists the parameters and variabiles in the pipelimit module.
@@ -325,7 +325,7 @@ sercmd cfg.set_now_string ratelimit reply_reason "Limiting"
:pl_stats:_reply_fifo_file_
_empty_line_
-5.2. pl_set_pipe
+5.2. pl_set_pipe
Sets the pipe parameters for the given pipe id.
@@ -343,7 +343,7 @@ sercmd cfg.set_now_string ratelimit reply_reason "Limiting"
10
_empty_line_
-5.3. pl_get_pipes
+5.3. pl_get_pipes
Gets the list of in use pipes.
@@ -355,7 +355,7 @@ sercmd cfg.set_now_string ratelimit reply_reason "Limiting"
:pl_get_pipes:_reply_fifo_file_
_empty_line_
-5.4. pl_set_pid
+5.4. pl_set_pid
Sets the PID Controller parameters for the Feedback Algorithm.
@@ -373,7 +373,7 @@ sercmd cfg.set_now_string ratelimit reply_reason "Limiting"
0.5
_empty_line_
-5.5. pl_get_pid
+5.5. pl_get_pid
Gets the list of in use PID Controller parameters.
@@ -385,7 +385,7 @@ sercmd cfg.set_now_string ratelimit reply_reason "Limiting"
:pl_get_pid:_reply_fifo_file_
_empty_line_
-5.6. pl_push_load
+5.6. pl_push_load
Force the value of the load parameter. This command is useful for
testing the Feedback algorithm.
diff --git a/modules/pipelimit/doc/pipelimit_admin.xml b/modules/pipelimit/doc/pipelimit_admin.xml
index b630d99..29df018 100644
--- a/modules/pipelimit/doc/pipelimit_admin.xml
+++ b/modules/pipelimit/doc/pipelimit_admin.xml
@@ -296,7 +296,7 @@ sercmd cfg.set_now_string ratelimit reply_reason "Limiting"
</section>
<section>
<title>
- <function moreinfo="none">pl_drop([[min ], max])</function>
+ <function moreinfo="none">pl_drop([ [min ], max ])</function>
</title>
<para>
For the current request, a "503 - Server Unavailable" reply is sent back.
More information about the sr-dev
mailing list