Fix various typos throughout documentation and code

OpenSIPS · Mar 5, 2014 · 1f47b10 · 1f47b10
1 parent 15784be
commit 1f47b10
Show file tree

Hide file tree

Showing 28 changed files with 219 additions and 206 deletions.
diff --git a/mem/f_malloc.c b/mem/f_malloc.c
@@ -338,7 +338,7 @@ void* fm_malloc(struct fm_block* qm, unsigned long size)
 	}
 	/* not found, bad! */
 
-	LM_WARN("Not enough free memory, will atempt defragmenation\n");
+	LM_WARN("Not enough free memory, will atempt defragmentation\n");
 
 	for( frag = qm->first_frag; (char*)frag < (char*)qm->last_frag;  )
 	{

diff --git a/modules/auth/README b/modules/auth/README
@@ -124,7 +124,7 @@ Chapter 1. Admin Guide
 
    The module depends on the following modules (in the other words
    the listed modules must be loaded before this module):
-     * signalign -- Signaling module
+     * signaling -- Signaling module
 
 1.3.2. External Libraries or Applications
 

diff --git a/modules/auth/doc/auth_admin.xml b/modules/auth/doc/auth_admin.xml
@@ -51,7 +51,7 @@
 			the listed modules must be loaded before this module):
 			<itemizedlist>
 			<listitem>
-				<para><emphasis>signalign</emphasis> -- Signaling module</para>
+				<para><emphasis>signaling</emphasis> -- Signaling module</para>
 			</listitem>
 			</itemizedlist>
 			</para>

diff --git a/modules/dialog/README b/modules/dialog/README
@@ -454,9 +454,9 @@ modparam("dialog", "db_url", "dbdriver://username:password@dbhost/dbname
    The supported modes are:
      * 0 - NO_DB - the memory content is not flushed into DB;
      * 1 - REALTIME - any dialog information changes will be
-       reflected into the database immediatly.
+       reflected into the database immediately.
      * 2 - DELAYED - the dialog information changes will be
-       flushed into DB periodically, based on a timre routine.
+       flushed into the DB periodically, based on a timer routine.
      * 3 - SHUTDOWN - the dialog information will be flushed into
        DB only at shutdown - no runtime updates.
 
@@ -471,7 +471,7 @@ modparam("dialog", "db_mode", 1)
 
    The interval (seconds) at which to update dialogs' information
    if you chose to store the dialogs' info at a given interval. A
-   too short interval will generate intensiv database operations,
+   too short interval will generate intensive database operations,
    a too large one will not notice short dialogs.
 
    Default value is “60”.
@@ -1011,12 +1011,14 @@ create_dialog("B");
 
 1.7.5.  get_dialog_info(attr,var,key,key_val)
 
-   The function extracts a dialog value from another dialog - it
-   search through all existing (ongoing) dialogs for a dialog that
-   has a dialog variable named "key" with the value "key_val" (so
-   a dialog where $dlg_val(key)=="key_val") - once found, it
-   return in pvar "var" the value of the the dialog variable
-   "attr" from the found dialog.
+   The function extracts a dialog value from another dialog. It
+   first searches through all existing (ongoing) dialogs for a
+   dialog that has a dialog variable named "key" with the value
+   "key_val" (so a dialog where $dlg_val(key)=="key_val"). If
+   found, it returns the value of the dialog variable "attr" from
+   the found dialog in the "var" pseudo-variable, otherwise
+   nothing is written in "var", and a negative error code is
+   returned.
 
    NOTE: the function does not require to be called in the context
    of a dialog - you can use it whenever / whereever for searching
@@ -1447,7 +1449,7 @@ if (has_totag()  && (uri == myself)  && is_method("INVITE|ACK|BYE|UPDATE
    description the associated context from modules sitting on top
    of the dialog module. This function also prints the dialog's
    values. In case of binary values, the non-printable chars are
-   represented in hexa (e.g. \x00).
+   represented in hex (e.g. \x00)
 
    Name: dlg_list_ctx
 

diff --git a/modules/dialog/dialog.c b/modules/dialog/dialog.c
@@ -361,7 +361,7 @@ static int fixup_profile(void** param, int param_no)
 	if (param_no==1) {
 		profile = search_dlg_profile( &s );
 		if (profile==NULL) {
-			LM_CRIT("profile <%s> not definited\n",s.s);
+			LM_CRIT("profile <%s> not defined\n",s.s);
 			return E_CFG;
 		}
 		pkg_free(*param);

diff --git a/modules/dialog/doc/dialog_admin.xml b/modules/dialog/doc/dialog_admin.xml
@@ -400,12 +400,12 @@ modparam("dialog", "db_url", "&exampledb;")
 			</para></listitem>
 			<listitem><para>
 				<emphasis>1 - REALTIME</emphasis> - any dialog information 
-				changes will be reflected into the database immediatly.
+				changes will be reflected into the database immediately.
 			</para></listitem>
 			<listitem><para>
 				<emphasis>2 - DELAYED</emphasis> - the dialog information 
-				changes will be flushed into DB periodically, based on a
-				timre routine.
+				changes will be flushed into the DB periodically, based on a
+				timer routine.
 			</para></listitem>
 			<listitem><para>
 				<emphasis>3 - SHUTDOWN</emphasis> - the dialog information 
@@ -431,7 +431,7 @@ modparam("dialog", "db_mode", 1)
 		<title><varname>db_update_period</varname> (integer)</title>
 		<para>
 			The interval (seconds) at which to update dialogs' information if you chose to store the dialogs' info at a given interval.
-			A too short interval will generate intensiv database operations, a too large one will not notice short dialogs.
+			A too short interval will generate intensive database operations, a too large one will not notice short dialogs.
 		</para>
 		<para>
 		<emphasis>
@@ -1349,12 +1349,13 @@ create_dialog("B");
 		<function moreinfo="none">get_dialog_info(attr,var,key,key_val)</function>
 		</title>
 		<para>
-		The function extracts a dialog value from another dialog - it search 
-		through all existing (ongoing) dialogs for a dialog
-		that has a dialog variable named "key" with the value "key_val" 
-		(so a dialog where $dlg_val(key)=="key_val") - once found, it return
-		in pvar "var" the value of the the dialog variable "attr" from the 
-		found dialog.
+		The function extracts a dialog value from another dialog. It first searches
+		through all existing (ongoing) dialogs for a dialog that has a dialog
+		variable named "key" with the value "key_val" 
+		(so a dialog where $dlg_val(key)=="key_val"). If found, it returns
+		the value of the dialog variable "attr" from the 
+		found dialog in the "var" pseudo-variable, otherwise nothing is written
+		in "var", and a negative error code is returned.
 		</para>
 		<para>
 		NOTE: the function does not require to be called in the context of

diff --git a/modules/dispatcher/README b/modules/dispatcher/README
@@ -136,9 +136,9 @@ Chapter 1. Admin Guide
 1.1. Overview
 
    This modules implements a dispatcher for destination addresses.
-   It computes hashes over parts of the request and selects an
-   address from a destination set. The selected address is then
-   used as outbound proxy.
+   It computes hashes over various parts of the request and
+   selects an address from a destination set. The selected address
+   is then used as outbound proxy.
 
    The module can be used as a stateless load balancer, having no
    guarantee of fair distribution.
@@ -170,8 +170,8 @@ Chapter 1. Admin Guide
 
    Example 1.1. Set “db_url” parameter
 ...
-modparam("dispatcher", "db_url", "mysql://user:passwb@localhost/databas
-e")
+modparam("dispatcher", "db_url", "mysql://user:passwb@localhost/database
+")
 ...
 
 1.3.2. flags (int)
@@ -546,7 +546,9 @@ modparam("dispatcher", "socket_col", "my_sock")
 
 1.4.1.  ds_select_dst(set, alg [, max_results])
 
-   The method selects a destination from addresses set.
+   The method selects a destination from the given set of
+   addresses. It will overwrite the "destination URI" of a SIP
+   request ($du).
 
    Meaning of the parameters is as follows:
      * set - the id of the set or a list of sets from where to
@@ -799,7 +801,7 @@ _empty_line_
 # sample config file for dispatcher module
 #
 
-debug=9          # debug level (cmd line: -dddddddddd)
+debug=9          # debug level (cmd line: -ddddddd)
 fork=no
 log_stderror=yes  # (cmd line: -E)
 
@@ -824,8 +826,8 @@ loadmodule "dispatcher.so"
 # ----------------- setting module-specific parameters ---------------
 # -- dispatcher params --
 
-modparam("dispatcher", "db_url", "mysql://opensips:opensipsrw@localhost
-/opensips")
+modparam("dispatcher", "db_url", "mysql://opensips:opensipsrw@localhost/
+opensips")
 
 route{
         if ( !mf_process_maxfwd_header("10") )
@@ -848,69 +850,69 @@ Chapter 2. Frequently Asked Questions
 
    2.1.
 
-   Does dispatcher provide a fair distribution?
+       Does dispatcher provide a fair distribution?
 
-   There is no guarantee of that. You should do some measurements
-   to decide what distribution algorithm fits better in your
-   environment.
+       There is no guarantee of that. You should do some measurements
+       to decide what distribution algorithm fits better in your
+       environment.
 
    2.2.
 
-   Is dispatcher dialog stateful?
+       Is dispatcher dialog stateful?
 
-   No. Dispatcher is stateless, although some distribution
-   algorithms are designed to select same destination for
-   subsequent requests of the same dialog (e.g., hashing the
-   call-id).
+       No. Dispatcher is stateless, although some distribution
+       algorithms are designed to select same destination for
+       subsequent requests of the same dialog (e.g., hashing the
+       call-id).
 
    2.3.
 
-   What happend with the ds_is_from_list() function?
+       What happend with the ds_is_from_list() function?
 
-   The function was replaced by the more generic ds_is_in_list()
-   function that takes as parameters the IP and PORT to test
-   against the dispatcher list.
+       The function was replaced by the more generic ds_is_in_list()
+       function that takes as parameters the IP and PORT to test
+       against the dispatcher list.
 
-   ds_is_from_list() == ds_is_in_list("$si","$sp")
+       ds_is_from_list() == ds_is_in_list("$si","$sp")
 
    2.4.
 
-   What happend with the list_file module parameter ?
+       What happend with the list_file module parameter ?
 
-   The support for text file (for provisioning destinations) was
-   dropped. Only the DB support (provisioning via a DB table) is
-   now available - if you still want to use a text file for
-   provisioning, use db_text DB driver (DB emulated via text
-   files)
+       The support for text file (for provisioning destinations) was
+       dropped. Only the DB support (provisioning via a DB table) is
+       now available - if you still want to use a text file for
+       provisioning, use db_text DB driver (DB emulated via text
+       files)
 
    2.5.
 
-   Where can I find more about OpenSIPS?
+       Where can I find more about OpenSIPS?
 
-   Take a look at http://www.opensips.org/.
+       Take a look at http://www.opensips.org/.
 
    2.6.
 
-   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.opensips.org/cgi-bin/mailman/listinfo/users
-     * Developer Mailing List -
-       http://lists.opensips.org/cgi-bin/mailman/listinfo/devel
+       First at all check if your question was already answered on one
+       of our mailing lists:
+         * User Mailing List -
+           http://lists.opensips.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://lists.opensips.org/cgi-bin/mailman/listinfo/devel
 
-   E-mails regarding any stable version should be sent to
-   <users@lists.opensips.org> and e-mail regarding development
-   versions or SVN snapshots should be send to
-   <devel@lists.opensips.org>.
+       E-mails regarding any stable version should be sent to
+       <users@lists.opensips.org> and e-mail regarding development
+       versions or SVN snapshots should be send to
+       <devel@lists.opensips.org>.
 
-   If you want to keep the mail private, send it to
-   <users@lists.opensips.org>.
+       If you want to keep the mail private, send it to
+       <users@lists.opensips.org>.
 
    2.7.
 
-   How can I report a bug?
+       How can I report a bug?
 
-   Please follow the guidelines provided at:
-   https://github.com/OpenSIPS/opensips/issues
+       Please follow the guidelines provided at:
+       https://github.com/OpenSIPS/opensips/issues
diff --git a/modules/dispatcher/doc/dispatcher.cfg b/modules/dispatcher/doc/dispatcher.cfg
@@ -3,7 +3,7 @@
 # sample config file for dispatcher module
 #
 
-debug=9          # debug level (cmd line: -dddddddddd)
+debug=9          # debug level (cmd line: -ddddddd)
 fork=no
 log_stderror=yes  # (cmd line: -E)
 

diff --git a/modules/dispatcher/doc/dispatcher_admin.xml b/modules/dispatcher/doc/dispatcher_admin.xml
@@ -8,8 +8,8 @@
 	<title>Overview</title>
 	<para>
 		This modules implements a dispatcher for destination addresses. It 
-		computes hashes over parts of the request and selects an address from
-		a destination set. The selected address is then used as outbound
+		computes hashes over various parts of the request and selects an
+		address from a destination set. The selected address is then used as outbound
 		proxy.
 	</para>
 	<para>
@@ -691,7 +691,8 @@ modparam("dispatcher", "socket_col", "my_sock")
 		<function moreinfo="none">ds_select_dst(set, alg [, max_results])</function>
 		</title>
 		<para>
-		The method selects a destination from addresses set.
+		The method selects a destination from the given set of addresses. It will
+		overwrite the "destination URI" of a SIP request (<emphasis>$du</emphasis>).
 		</para>
 		<para>Meaning of the parameters is as follows:</para>
 		<itemizedlist>