Fix various documentation typos or shortcomings

doc/build-contrib.sh

@@ -293,6 +293,7 @@ fix_authors=(
 
   # db_postgres
   ["9e6730ec4d2e876f6b2372f1b5fb5703112079fc"]="Ruslan Bukin"
+  ["2d80fcf1cfed82680a016fe723da03a303f73aff"]="Norman Brandinger"
 
   # db_text
   ["e8c8262d23b26bdb45b8074c6e518825ea0ca6de"]="Henning Westerholt"

main.c

@@ -240,7 +240,7 @@ int tcpthreshold = 0;
 int sip_warning = 0;
 /* should localy-generated messages include server's signature? */
 int server_signature=1;
-/* Server header to be used when proxy generates request as UAS.
+/* Server header to be used when proxy generates a reply as UAS.
    Default is to use SERVER_HDR CRLF (assigned later).
 */
 str server_header = {SERVER_HDR,sizeof(SERVER_HDR)-1};

mi/mi.h

@@ -54,7 +54,7 @@
 #define JSONRPC_SERVER_ERR_CODE	   -32000
 #define JSONRPC_SERVER_ERR_MSG     "Server error"
 
-#define ERR_DET_POS_PARAMS_S "Commands only supports named parameters"
+#define ERR_DET_POS_PARAMS_S "Command only supports named parameters"
 #define ERR_DET_AMBIG_CALL_S "Ambiguous call"
 
 

modules/auth_db/doc/auth_db_admin.xml

@@ -89,7 +89,7 @@ modparam("auth_db", "db_url", "&exampledb;")
 		<itemizedlist>
 			<listitem><para><emphasis>1 (calculate HA1)</emphasis> - the loaded
 			password is a plaintext password, so OpenSIPS will internally
-			calculate the HA1. As the passwors will be loaded from the column
+			calculate the HA1. As the passwords will be loaded from the column
 			specified in the <quote>password_column</quote> parameter, be sure
 			this parameter points to a column holding a plaintext password
 			(by default, this parameter points to <quote>ha1</quote> column);

modules/avpops/doc/avpops_admin.xml

@@ -563,8 +563,8 @@ avp_db_query("DELETE FROM subscriber", , $avp(id));
 				<title><function>avp_delete</function> usage</title>
 				<programlisting format="linespecific">
 ...
-avp_delete("$avp(678)/g");
-avp_delete("$avp(email)");
+avp_delete("$avp(email)"); # delete topmost (lastly set) value from $avp(email)
+avp_delete("$avp(678)/g"); # fully purge $avp(678)
 avp_delete("i");
 avp_delete("a3");
 ...

modules/cachedb_local/doc/cachedb_local_admin.xml

@@ -149,7 +149,7 @@ cache_store("local:group2", ...)
 ## creating collection1 with default size (512) and collection2 with custom size
 ## 2^5 (32); we also changed the size of the default collection, which would have been
 ## created anyway from 2^9 - 512 (default value) to 2^4 - 16
-modparam("cachedb_local", "cache_collections", "collection1; collection2=5; default=4")
+modparam("cachedb_local", "cache_collections", "collection1;collection2=5;default=4")
 ...
 	</programlisting>
 		</example>

modules/cachedb_mongodb/doc/cachedb_mongodb_admin.xml

@@ -170,7 +170,7 @@ modparam("cachedb_mongodb", "cachedb_url",
 
 # Connect to a <emphasis>mongod</emphasis> replica set
 modparam("cachedb_mongodb", "cachedb_url",
-         "mongodb://10.0.0.10,10.0.0.11:27017/opensipsDB.dialog?replSet=my-set")
+         "mongodb://10.0.0.10,10.0.0.11:27017/opensipsDB.dialog?replicaSet=my-set")
 
 # Connect to a <emphasis>mongos</emphasis> instance (routes to a sharded cluster)
 modparam("cachedb_mongodb", "cachedb_url",

modules/cfgutils/doc/cfgutils_admin.xml

@@ -167,7 +167,7 @@ modparam("cfgutils", "varset", "gw=s:sip:11.11.11.11;transport=tcp")
 </programlisting>
 	    </example>
 	</section>
-	<section>
+	<section id="param_lock_pool_size" xreflabel="lock_pool_size">
 		<title><varname>lock_pool_size</varname> (integer)</title>
 		<para>
 		The number of dynamic script locks to be allocated at &osips; startup. This

modules/clusterer/api.h

@@ -204,7 +204,7 @@ typedef int (*sync_chunk_iter_f)(bin_packet_t *packet);
 typedef int (*shtag_get_f)(str *tag, int cluster_id);
 
 /*
- * Activates an sharing tag by name and cluster ID
+ * Activates a sharing tag by name and cluster ID
  *
  * Returns -1 if error or the new status of the tag (>=0)
  */

modules/dialog/doc/dialog_admin.xml

@@ -1380,7 +1380,7 @@ modparam("dialog", "replicate_profiles_expire", 10)
 		Also, the end-points can be pinged via in-dialog Re-INVITE SIP messages. This
 		behaviour is controlled via the "R" flags for pinging the caller side, and
 		the "r" flag for re-invite pinging the callee side. If one end-points fails
-		to re-negociate the session via the Re-INVITE pings, OpenSIPS will terminate
+		to re-negotiate the session via the Re-INVITE pings, OpenSIPS will terminate
 		the dialog from the middle
 
 		The string parameter can also contain "B" to activate the bye on
@@ -2691,11 +2691,11 @@ set_dlg_sharing_tag("vip1");
 		<itemizedlist>
 			<listitem><para>
 				<emphasis>callid</emphasis> - the callid of the dialog you need to trigger
-					the sequentiam message for.
+					the sequential message for.
 			</para></listitem>
 			<listitem><para>
 				<emphasis>method</emphasis> - (optional) the method used for the sequential
-					mesasge. Default value is <emphasis>INVITE</emphasis>.
+					message. Default value is <emphasis>INVITE</emphasis>.
 			</para></listitem>
 			<listitem><para>
 				<emphasis>mode</emphasis> - (optional) can be used to tune the behavior of
@@ -2742,7 +2742,7 @@ set_dlg_sharing_tag("vip1");
 							if the <emphasis>mode=challenge-caller</emphasis>, the message will
 							contain the body sent to &osips; by the callee. This is useful when
 							you need to alter the body previously sent to the caller, because you
-							want to re-negociate a different media proxy for the call. This can
+							want to re-negotiate a different media proxy for the call. This can
 							be achieved by catching the generated request in
 							<emphasis>local_route</emphasis>, and re-engage the Media proxy.
 					</para></listitem>
@@ -2751,7 +2751,7 @@ set_dlg_sharing_tag("vip1");
 							message generated the last body sent to that UAC. For example,
 							if the <emphasis>mode=challenge-caller</emphasis>, the message will
 							contain the last body sent by &osips; to the caller. This is useful
-							in a high availability scenario when trying to re-negociate the
+							in a high availability scenario when trying to re-negotiate the
 							contact of the server, but there is no need to alter the body sent
 							earlier.
 					</para></listitem>
@@ -2764,7 +2764,7 @@ set_dlg_sharing_tag("vip1");
 			</para></listitem>
 		</itemizedlist>
 		<para>
-			This functions runs in asynchronous mode and returns the status code and reason
+			This functions runs asynchronously and returns the status code and reason
 			of the last reply received for either the <emphasis>challenge</emphasis> or normal mode.
 		</para>
 		<para>

modules/dispatcher/dispatch.c

@@ -669,7 +669,7 @@ int init_ds_db(ds_partition_t *partition)
 		return -1;
 	} else if (!supported_ds_version(_ds_table_version)) {
 		LM_ERR("invalid table version (found %d , required %d)\n"
-			"(use opensipsdbctl reinit)\n",
+			"(use opensips-cli to migrate to latest schema)\n",
 			_ds_table_version, DS_TABLE_VERSION );
 		return -1;
 	}

modules/dispatcher/ds_fixups.c

@@ -365,7 +365,7 @@ int fixup_flags(str* param)
 				break;
 
 			default:
-				LM_ERR("Invalid definition\n");
+				LM_ERR("Invalid flag: '%c'\n", param->s[index]);
 				return -1;
 		}
 	}

modules/mediaproxy/doc/mediaproxy_admin.xml

@@ -449,7 +449,7 @@ if (is_method("INVITE")) {
       <title>Using the <function>end_media_session</function> function</title>
         <programlisting format="linespecific">
 ...
-if (is_method("BYE") {
+if (is_method("BYE")) {
     end_media_session();
 }
 ...

modules/mid_registrar/mid_registrar.h

@@ -100,7 +100,7 @@ struct mid_reg_info {
 
 	udomain_t *dom; /* used during 200 OK ul_api operations */
 	str aor;        /* used during both "reg out" and "resp in" */
-	str ownership_tag; /* used during both "reg out" and "resp in" */
+	str ownership_tag; /* a sharing tag which helps decide ownership */
 
 	/* ucontact_info dup'ed fields */
 	str user_agent;

modules/nathelper/doc/nathelper_admin.xml

@@ -649,7 +649,7 @@ if (search("User-Agent: Cisco ATA.*") {
 				<listitem>
 					<para><emphasis>0x02</emphasis> - rewrite media
 					&ip; address (c=) with source address of the message
-					or the provided IP address (the provide IP address take
+					or the provided IP address (the provided IP address takes
 					precedence over the source address).</para>
 				</listitem>
 				<listitem>
@@ -659,7 +659,7 @@ if (search("User-Agent: Cisco ATA.*") {
 				<listitem>
 					<para><emphasis>0x08</emphasis> - rewrite IP from
 					origin description (o=) with source address of the message
-					or the provided IP address (the provide IP address take
+					or the provided IP address (the provided IP address takes
 					precedence over the source address).</para>
 				</listitem>
 				<listitem>

modules/presence/doc/presence_admin.xml

@@ -680,26 +680,26 @@ modparam("presence", "pres_htable_size", 11)
 		<itemizedlist>
 			<listitem>
 				<para>
-				<emphasis>force_active</emphasis> (int, optional) - options parameter that 
-				controlls what is the default policy (of the presentity) on 
+				<emphasis>force_active</emphasis> (int, optional) - optional parameter that 
+				controls what is the default policy (of the presentity) on 
 				accepting new subscriptions (accept or reject) - of course, 
 				this parameter makes sense only when using a presence 
 				configuration with privacy rules enabled (force_active 
 				parameter in presence_xml module is not set).
 				</para>
 				<para>
 				There are scenarios where the presentity (the party you 
-				subscribe to) can not upload an XCAP document with it's 
-				privacy rules (to controll which watchers are allowed to 
-				subscribe to it). In such case, from script level, you can
+				subscribe to) can not upload an XCAP document with its
+				privacy rules (to control which watchers are allowed to 
+				subscribe to it). In such cases, from script level, you can
 				force the presence server to consider the current subscription
 				allowed (with Subscription-Status:active) by calling the 
 				handle_subscribe() function with the integer parameter "1".
 				</para>
 			</listitem>
 			<listitem>
 				<para>
-				<emphasis>sharing_tag</emphasis> (string, optional) - options parameter telling
+				<emphasis>sharing_tag</emphasis> (string, optional) - optional parameter telling
 				the owner tag (for the subscription) in clusetering scenarios 
 				where the subscription data is shared between multiple 
 				servers - see the <xref linkend="presence_clustering"/>

modules/proto_tls/doc/proto_tls_admin.xml

@@ -357,7 +357,7 @@ modparam("proto_tls", "cert_check_on_conn_reusage", 1)
 		</example>
 	</section>
 
-	<section id="param_tls_trace-destination" xreflabel="trace-destination">
+	<section id="param_tls_trace_destination" xreflabel="trace_destination">
 		<title><varname>trace_destination</varname> (string)</title>
 		<para>
 			Trace destination as defined in the tracing module. Currently
@@ -394,7 +394,7 @@ modparam("proto_tls", "trace_destination", "hep_dest")
 		<title><varname>trace_on</varname> (int)</title>
 		<para>
 			This controls whether tracing for tls is on or not. You still need to define
-			<xref linkend="trace-destination"/>in order to work, but this value will be
+			<xref linkend="param_tls_trace_destination"/>in order to work, but this value will be
 			controlled using mi function <xref linkend="mi_tls_trace"/>.
 		</para>
 		<emphasis>
@@ -419,7 +419,7 @@ modparam("proto_tls", "trace_on", 1)
 			connection. To disable tracing for a specific connection the last call in
 			this route must be <emphasis role="bold">drop</emphasis>, any other exit
 			mode resulting in tracing the current connection ( of course you still
-			have to define a <xref linkend="trace-destination"/> and trace must be
+			have to define a <xref linkend="param_tls_trace_destination"/> and trace must be
 			on at the time this connection is opened.
 		</para>
 		<para>

modules/ratelimit/doc/ratelimit_admin.xml

@@ -506,7 +506,7 @@ modparam("ratelimit", "slot_period", 100)
 		specified when the pipe was created will be considered.
 		</para>
 		<para>
-		NOTE: This function increments the pipe's couter every time it is
+		NOTE: This function increments the pipe's counter every time it is
 		called, even if the call should be declined. Therefore If you are using
 		ratelimit to limit only successful traffic, you need to explicitely
 		decrease the counter for the declined calls using the
@@ -682,7 +682,7 @@ modparam("ratelimit", "slot_period", 100)
 		<itemizedlist>
 			<listitem><para>
 			<emphasis>pipe</emphasis> - indicates the name of the pipe whose
-			couter should be reset.
+			counter should be reset.
 			</para></listitem>
 		</itemizedlist>
 		<para>

modules/registrar/doc/registrar_admin.xml

@@ -258,7 +258,7 @@ modparam("registrar", "default_q", 1000)
 		<title>Set <varname>tcp_persistent_flag</varname> parameter</title>
 		<programlisting format="linespecific">
 ...
-modparam("registrar", "tcp_persistent_flag", 7)
+modparam("registrar", "tcp_persistent_flag", "TCP_PERSIST_DURATION")
 ...
 </programlisting>
 		</example>

modules/rest_client/doc/rest_client_admin.xml

@@ -93,7 +93,7 @@ modparam("rest_client", "connection_timeout", 4)
 		<title><varname>connect_poll_interval</varname> (integer)</title>
 		<para>
 		Only relevant with async requests.  Allows complete control over how
-		quickly we want to detect libcurl's completed blocking TCP handshakes,
+		quickly we want to detect libcurl's completed blocking TCP/TLS handshakes,
 		so the async transfers can be put in the background.  A lower
 		<xref linkend="param_connect_poll_interval"/> may speed up all async
 		HTTP transfers, but will also increase CPU usage.

modules/sipmsgops/doc/sipmsgops_admin.xml

@@ -909,7 +909,7 @@ add_body_part("Hello World!", "text/plain");
 				</para></listitem>
 				<listitem><para><emphasis>-12</emphasis> - Bad hostname in R-URI.
 				</para></listitem>
-				<listitem><para><emphasis>-13</emphasis> - No Max-Forward header.
+				<listitem><para><emphasis>-13</emphasis> - No Max-Forwards header.
 				</para></listitem>
 				<listitem><para><emphasis>-14</emphasis> - No Contact header.
 				</para></listitem>

modules/tls_mgm/doc/tls_mgm_admin.xml

@@ -539,7 +539,7 @@ modparam("tls_mgm", "client_tls_domain_avp", "tls_match_dom")
 			<title><varname>client_sip_domain_avp</varname> (string)</title>
 			<para>
 			Name of the AVP that sets the SIP domain used in the TLS client
-			domain mathcing process.
+			domain matching process.
 			</para>
 			<para>
 			Note: If there is already an existing TLS connection to the remote target,

modules/tm/doc/tm_admin.xml

@@ -621,7 +621,7 @@ modparam("tm", "syn_branch", 0)
 		</para>
 		<para>
 		In mode 1, you can see the AVPs you set in request route, branch route
-		or failure route. The side efect is performance as more locking is 
+		or failure route. The side effect is performance as more locking is 
 		required in order to keep the AVP's list integrity.
 		</para>
 		<para>

modules/usrloc/doc/usrloc_admin.xml

@@ -833,9 +833,10 @@ modparam("usrloc", "db_mode", 2)
 			expired contacts and flushes all modified or new contacts to
 			database.  Use this scheme if you encounter high-load peaks
 			and want them to process as fast as possible. The mode will
-			not help at all if the load is high all the time.  Also, latency
-			of this mode is much lower than latency of mode 1, but slightly
-			higher than latency of mode 0.
+			not help at all if the load is high all the time.  The
+			added latency on the SIP signaling when using this asynchronous
+			preset is much lower than the one added by the safe but
+			blocking, "single-instance-sql-write-through" preset.
 			</para>
 		</listitem>
 		<listitem>
@@ -1350,7 +1351,7 @@ modparam("usrloc", "latency_event_min_us_delta", 300000)
 		<title><varname>pinging_mode</varname> (string)</title>
 		<para>
 		Depending on the <xref linkend="param_cluster_mode"/>, the module
-		will perform contact pinging using one of at most two possible
+		can perform contact pinging using one of at most two possible
 		heuristics:
 		<itemizedlist>
 		<listitem>