From 59f8505d3597c2848ca05f64879d97a8748997ea Mon Sep 17 00:00:00 2001 From: Liviu Chircu Date: Wed, 29 May 2019 18:05:10 +0300 Subject: [PATCH] Fix various documentation typos or shortcomings --- doc/build-contrib.sh | 1 + main.c | 2 +- mi/mi.h | 2 +- modules/auth_db/doc/auth_db_admin.xml | 2 +- modules/avpops/doc/avpops_admin.xml | 4 ++-- modules/cachedb_local/doc/cachedb_local_admin.xml | 2 +- .../cachedb_mongodb/doc/cachedb_mongodb_admin.xml | 2 +- modules/cfgutils/doc/cfgutils_admin.xml | 2 +- modules/clusterer/api.h | 2 +- modules/dialog/doc/dialog_admin.xml | 12 ++++++------ modules/dispatcher/dispatch.c | 2 +- modules/dispatcher/ds_fixups.c | 2 +- modules/mediaproxy/doc/mediaproxy_admin.xml | 2 +- modules/mid_registrar/mid_registrar.h | 2 +- modules/nathelper/doc/nathelper_admin.xml | 4 ++-- modules/presence/doc/presence_admin.xml | 12 ++++++------ modules/proto_tls/doc/proto_tls_admin.xml | 6 +++--- modules/ratelimit/doc/ratelimit_admin.xml | 4 ++-- modules/registrar/doc/registrar_admin.xml | 2 +- modules/rest_client/doc/rest_client_admin.xml | 2 +- modules/sipmsgops/doc/sipmsgops_admin.xml | 2 +- modules/tls_mgm/doc/tls_mgm_admin.xml | 2 +- modules/tm/doc/tm_admin.xml | 2 +- modules/usrloc/doc/usrloc_admin.xml | 9 +++++---- 24 files changed, 43 insertions(+), 41 deletions(-) diff --git a/doc/build-contrib.sh b/doc/build-contrib.sh index dbda48e8f2..2383808d41 100755 --- a/doc/build-contrib.sh +++ b/doc/build-contrib.sh @@ -293,6 +293,7 @@ fix_authors=( # db_postgres ["9e6730ec4d2e876f6b2372f1b5fb5703112079fc"]="Ruslan Bukin" + ["2d80fcf1cfed82680a016fe723da03a303f73aff"]="Norman Brandinger" # db_text ["e8c8262d23b26bdb45b8074c6e518825ea0ca6de"]="Henning Westerholt" diff --git a/main.c b/main.c index 45b442fb93..0963eced0e 100644 --- a/main.c +++ b/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}; diff --git a/mi/mi.h b/mi/mi.h index 2a94831301..1e8a8eba20 100644 --- a/mi/mi.h +++ b/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" diff --git a/modules/auth_db/doc/auth_db_admin.xml b/modules/auth_db/doc/auth_db_admin.xml index ce2032b3ee..1828619db3 100644 --- a/modules/auth_db/doc/auth_db_admin.xml +++ b/modules/auth_db/doc/auth_db_admin.xml @@ -89,7 +89,7 @@ modparam("auth_db", "db_url", "&exampledb;") 1 (calculate HA1) - 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 password_column parameter, be sure this parameter points to a column holding a plaintext password (by default, this parameter points to ha1 column); diff --git a/modules/avpops/doc/avpops_admin.xml b/modules/avpops/doc/avpops_admin.xml index 39092dc5c5..5e97d344ed 100644 --- a/modules/avpops/doc/avpops_admin.xml +++ b/modules/avpops/doc/avpops_admin.xml @@ -563,8 +563,8 @@ avp_db_query("DELETE FROM subscriber", , $avp(id)); <function>avp_delete</function> usage ... -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"); ... diff --git a/modules/cachedb_local/doc/cachedb_local_admin.xml b/modules/cachedb_local/doc/cachedb_local_admin.xml index bfcea6fdf7..d0e1f67ad5 100644 --- a/modules/cachedb_local/doc/cachedb_local_admin.xml +++ b/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") ... diff --git a/modules/cachedb_mongodb/doc/cachedb_mongodb_admin.xml b/modules/cachedb_mongodb/doc/cachedb_mongodb_admin.xml index 1c73d1897b..f7eef01491 100644 --- a/modules/cachedb_mongodb/doc/cachedb_mongodb_admin.xml +++ b/modules/cachedb_mongodb/doc/cachedb_mongodb_admin.xml @@ -170,7 +170,7 @@ modparam("cachedb_mongodb", "cachedb_url", # Connect to a mongod 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 mongos instance (routes to a sharded cluster) modparam("cachedb_mongodb", "cachedb_url", diff --git a/modules/cfgutils/doc/cfgutils_admin.xml b/modules/cfgutils/doc/cfgutils_admin.xml index a2449eddbc..2ce2f468f6 100644 --- a/modules/cfgutils/doc/cfgutils_admin.xml +++ b/modules/cfgutils/doc/cfgutils_admin.xml @@ -167,7 +167,7 @@ modparam("cfgutils", "varset", "gw=s:sip:11.11.11.11;transport=tcp") -
+
<varname>lock_pool_size</varname> (integer) The number of dynamic script locks to be allocated at &osips; startup. This diff --git a/modules/clusterer/api.h b/modules/clusterer/api.h index 89db64ad40..7271156438 100644 --- a/modules/clusterer/api.h +++ b/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) */ diff --git a/modules/dialog/doc/dialog_admin.xml b/modules/dialog/doc/dialog_admin.xml index 5387bbf355..b173a739f4 100644 --- a/modules/dialog/doc/dialog_admin.xml +++ b/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"); callid - the callid of the dialog you need to trigger - the sequentiam message for. + the sequential message for. method - (optional) the method used for the sequential - mesasge. Default value is INVITE. + message. Default value is INVITE. mode - (optional) can be used to tune the behavior of @@ -2742,7 +2742,7 @@ set_dlg_sharing_tag("vip1"); if the mode=challenge-caller, 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 local_route, and re-engage the Media proxy. @@ -2751,7 +2751,7 @@ set_dlg_sharing_tag("vip1"); message generated the last body sent to that UAC. For example, if the mode=challenge-caller, 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. @@ -2764,7 +2764,7 @@ set_dlg_sharing_tag("vip1"); - 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 challenge or normal mode. diff --git a/modules/dispatcher/dispatch.c b/modules/dispatcher/dispatch.c index aab6e76bb6..eb68ba3729 100644 --- a/modules/dispatcher/dispatch.c +++ b/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; } diff --git a/modules/dispatcher/ds_fixups.c b/modules/dispatcher/ds_fixups.c index ea384405fa..924dda0c92 100644 --- a/modules/dispatcher/ds_fixups.c +++ b/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; } } diff --git a/modules/mediaproxy/doc/mediaproxy_admin.xml b/modules/mediaproxy/doc/mediaproxy_admin.xml index 3f5b5836c8..7609542c0c 100644 --- a/modules/mediaproxy/doc/mediaproxy_admin.xml +++ b/modules/mediaproxy/doc/mediaproxy_admin.xml @@ -449,7 +449,7 @@ if (is_method("INVITE")) { Using the <function>end_media_session</function> function ... -if (is_method("BYE") { +if (is_method("BYE")) { end_media_session(); } ... diff --git a/modules/mid_registrar/mid_registrar.h b/modules/mid_registrar/mid_registrar.h index 5dc03c0df2..f936dba484 100644 --- a/modules/mid_registrar/mid_registrar.h +++ b/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; diff --git a/modules/nathelper/doc/nathelper_admin.xml b/modules/nathelper/doc/nathelper_admin.xml index aa32087351..96c247eca9 100644 --- a/modules/nathelper/doc/nathelper_admin.xml +++ b/modules/nathelper/doc/nathelper_admin.xml @@ -649,7 +649,7 @@ if (search("User-Agent: Cisco ATA.*") { 0x02 - 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). @@ -659,7 +659,7 @@ if (search("User-Agent: Cisco ATA.*") { 0x08 - 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). diff --git a/modules/presence/doc/presence_admin.xml b/modules/presence/doc/presence_admin.xml index 86700873b5..40552c9b82 100644 --- a/modules/presence/doc/presence_admin.xml +++ b/modules/presence/doc/presence_admin.xml @@ -680,8 +680,8 @@ modparam("presence", "pres_htable_size", 11) - force_active (int, optional) - options parameter that - controlls what is the default policy (of the presentity) on + force_active (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 @@ -689,9 +689,9 @@ modparam("presence", "pres_htable_size", 11) 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". @@ -699,7 +699,7 @@ modparam("presence", "pres_htable_size", 11) - sharing_tag (string, optional) - options parameter telling + sharing_tag (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 diff --git a/modules/proto_tls/doc/proto_tls_admin.xml b/modules/proto_tls/doc/proto_tls_admin.xml index 42f153ecaf..16f15f4377 100644 --- a/modules/proto_tls/doc/proto_tls_admin.xml +++ b/modules/proto_tls/doc/proto_tls_admin.xml @@ -357,7 +357,7 @@ modparam("proto_tls", "cert_check_on_conn_reusage", 1)
-
+
<varname>trace_destination</varname> (string) Trace destination as defined in the tracing module. Currently @@ -394,7 +394,7 @@ modparam("proto_tls", "trace_destination", "hep_dest") <varname>trace_on</varname> (int) This controls whether tracing for tls is on or not. You still need to define - in order to work, but this value will be + in order to work, but this value will be controlled using mi function . @@ -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 drop, any other exit mode resulting in tracing the current connection ( of course you still - have to define a and trace must be + have to define a and trace must be on at the time this connection is opened. diff --git a/modules/ratelimit/doc/ratelimit_admin.xml b/modules/ratelimit/doc/ratelimit_admin.xml index e1822b2e8b..b0623afc68 100644 --- a/modules/ratelimit/doc/ratelimit_admin.xml +++ b/modules/ratelimit/doc/ratelimit_admin.xml @@ -506,7 +506,7 @@ modparam("ratelimit", "slot_period", 100) specified when the pipe was created will be considered. - 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) pipe - indicates the name of the pipe whose - couter should be reset. + counter should be reset. diff --git a/modules/registrar/doc/registrar_admin.xml b/modules/registrar/doc/registrar_admin.xml index e41f8b3c79..7b5b87202a 100644 --- a/modules/registrar/doc/registrar_admin.xml +++ b/modules/registrar/doc/registrar_admin.xml @@ -258,7 +258,7 @@ modparam("registrar", "default_q", 1000) Set <varname>tcp_persistent_flag</varname> parameter ... -modparam("registrar", "tcp_persistent_flag", 7) +modparam("registrar", "tcp_persistent_flag", "TCP_PERSIST_DURATION") ... diff --git a/modules/rest_client/doc/rest_client_admin.xml b/modules/rest_client/doc/rest_client_admin.xml index 7b167cca32..814e1ce95f 100644 --- a/modules/rest_client/doc/rest_client_admin.xml +++ b/modules/rest_client/doc/rest_client_admin.xml @@ -93,7 +93,7 @@ modparam("rest_client", "connection_timeout", 4) <varname>connect_poll_interval</varname> (integer) 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 may speed up all async HTTP transfers, but will also increase CPU usage. diff --git a/modules/sipmsgops/doc/sipmsgops_admin.xml b/modules/sipmsgops/doc/sipmsgops_admin.xml index 71a9376954..88167ebe3a 100644 --- a/modules/sipmsgops/doc/sipmsgops_admin.xml +++ b/modules/sipmsgops/doc/sipmsgops_admin.xml @@ -909,7 +909,7 @@ add_body_part("Hello World!", "text/plain"); -12 - Bad hostname in R-URI. - -13 - No Max-Forward header. + -13 - No Max-Forwards header. -14 - No Contact header. diff --git a/modules/tls_mgm/doc/tls_mgm_admin.xml b/modules/tls_mgm/doc/tls_mgm_admin.xml index d273aebb51..19bcc4c479 100644 --- a/modules/tls_mgm/doc/tls_mgm_admin.xml +++ b/modules/tls_mgm/doc/tls_mgm_admin.xml @@ -539,7 +539,7 @@ modparam("tls_mgm", "client_tls_domain_avp", "tls_match_dom") <varname>client_sip_domain_avp</varname> (string) Name of the AVP that sets the SIP domain used in the TLS client - domain mathcing process. + domain matching process. Note: If there is already an existing TLS connection to the remote target, diff --git a/modules/tm/doc/tm_admin.xml b/modules/tm/doc/tm_admin.xml index e1a9bbd98a..35dab995e4 100644 --- a/modules/tm/doc/tm_admin.xml +++ b/modules/tm/doc/tm_admin.xml @@ -621,7 +621,7 @@ modparam("tm", "syn_branch", 0) 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. diff --git a/modules/usrloc/doc/usrloc_admin.xml b/modules/usrloc/doc/usrloc_admin.xml index 275697bc06..cc12b4f0aa 100644 --- a/modules/usrloc/doc/usrloc_admin.xml +++ b/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. @@ -1350,7 +1351,7 @@ modparam("usrloc", "latency_event_min_us_delta", 300000) <varname>pinging_mode</varname> (string) Depending on the , 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: