Skip to content

Commit

Permalink
Fix various doc typos; Improve wording
Browse files Browse the repository at this point in the history
(cherry picked from commit dd7b3da)
  • Loading branch information
liviuchircu committed Aug 16, 2022
1 parent 161c541 commit 7cdbc99
Show file tree
Hide file tree
Showing 16 changed files with 51 additions and 47 deletions.
2 changes: 1 addition & 1 deletion db/schema/dr_carriers.xml
Expand Up @@ -61,7 +61,7 @@
<type>string</type>
<default>N</default>
<size>1</size>
<description>The sorting algorithm to be employed for the carriers's
<description>The sorting algorithm to be employed for the carrier's
destinations when do_routing() is called. Possible values:
'N' (default; no sorting, preserve given order),
'W' (weight based sorting),
Expand Down
2 changes: 1 addition & 1 deletion lib/reg/doc/reg_modparams.xml
Expand Up @@ -7,7 +7,7 @@
and including the given value to the expiration interval of a
newly registered contact. For example, if this parameter is set to
<emphasis>100</emphasis> and a phone registers for 1800 sec, the final
expiry will be random number in the [1700, 1900] interval.
expiry will be a random number in the [1700, 1900] interval.
<para>
By randomizing the registration lifetimes of the contacts, the
server is better equipped to deal with a post-restart <emphasis>registration
Expand Down
41 changes: 23 additions & 18 deletions modules/auth/doc/auth_admin.xml
Expand Up @@ -108,7 +108,8 @@ modparam("auth", "secret", "johndoessecretphrase")
</programlisting>
</example>
</section>
<section>

<section id="param_nonce_expire" xreflabel="nonce_expire">
<title><varname>nonce_expire</varname> (integer)</title>
<para>
Nonces have limited lifetime. After a given period of time nonces
Expand All @@ -130,7 +131,8 @@ modparam("auth", "nonce_expire", 15) # Set nonce_expire to 15s
</programlisting>
</example>
</section>
<section>

<section id="param_rpid_prefix" xreflabel="rpid_prefix">
<title><varname>rpid_prefix</varname> (string)</title>
<para>
Prefix to be added to Remote-Party-ID header field just before
Expand All @@ -146,7 +148,8 @@ modparam("auth", "rpid_prefix", "Whatever &lt;")
</programlisting>
</example>
</section>
<section>

<section id="param_rpid_suffix" xreflabel="rpid_suffix">
<title><varname>rpid_suffix</varname> (string)</title>
<para>
Suffix to be added to Remote-Party-ID header field after the URI
Expand All @@ -163,7 +166,8 @@ modparam("auth", "rpid_suffix", "@1.2.3.4>")
</programlisting>
</example>
</section>
<section>

<section id="param_realm_prefix" xreflabel="realm_prefix">
<title><varname>realm_prefix</varname> (string)</title>
<para>
Prefix to be automatically strip from realm. As an alternative to
Expand All @@ -184,7 +188,8 @@ modparam("auth", "realm_prefix", "sip.")
</programlisting>
</example>
</section>
<section>

<section id="param_rpid_avp" xreflabel="rpid_avp">
<title><varname>rpid_avp</varname> (string)</title>
<para>
Full AVP specification for the AVP which
Expand All @@ -206,8 +211,8 @@ modparam("auth", "rpid_avp", "$avp(caller_rpid)")
</programlisting>
</example>
</section>
<section>

<section id="param_username_spec" xreflabel="username_spec">
<title><varname>username_spec</varname> (string)</title>
<para>
This name of the pseudo-variable that will hold the username.
Expand All @@ -223,7 +228,7 @@ modparam("auth", "username_spec", "$var(username)")
</example>
</section>

<section>
<section id="param_password_spec" xreflabel="password_spec">
<title><varname>password_spec</varname> (string)</title>
<para>
This name of the pseudo-variable that will hold the password.
Expand All @@ -239,7 +244,7 @@ modparam("auth", "password_spec", "$var(password)")
</example>
</section>

<section>
<section id="param_calculate_ha1" xreflabel="calculate_ha1">
<title><varname>calculate_ha1</varname> (integer)</title>
<para>
This parameter tells the server whether it should expect plaintext
Expand All @@ -263,7 +268,7 @@ modparam("auth", "calculate_ha1", 1)
</example>
</section>

<section>
<section id="param_disable_nonce_check" xreflabel="disable_nonce_check">
<title><varname>disable_nonce_check</varname> (int)</title>
<para>
By setting this parameter you disable the security mechanism
Expand Down Expand Up @@ -363,7 +368,7 @@ modparam("auth", "disable_nonce_check", 1)
...
if (!www_authorize("siphub.net", "subscriber")) {
www_challenge("siphub.net", "auth,auth-int", "MD5,SHA-512-256");
};
}
...
</programlisting>
</example>
Expand Down Expand Up @@ -393,11 +398,11 @@ if (!www_authorize("siphub.net", "subscriber")) {
...
$var(secure_algorithms) = "sha-256,sha-512-256";
...
if (!proxy_authorize("", "subscriber)) {
if (!proxy_authorize("", "subscriber")) {
...
proxy_challenge("", "auth", $var(secure_algorithms)); # Realm will be autogenerated
# MD5 won't be allowed
};
}
...
</programlisting>
</example>
Expand All @@ -423,9 +428,9 @@ if (!proxy_authorize("", "subscriber)) {
<title>consume_credentials example</title>
<programlisting format="linespecific">
...
if (www_authorize("", "subscriber)) {
if (www_authorize("", "subscriber")) {
consume_credentials();
};
}
...
</programlisting>
</example>
Expand All @@ -450,7 +455,7 @@ if (www_authorize("", "subscriber)) {
...
if (is_rpid_user_e164()) {
# do something here
};
}
...
</programlisting>
</example>
Expand Down Expand Up @@ -585,7 +590,7 @@ $var(username)="abc";
$var(password)="xyz";
if (!pv_www_authorize("opensips.org")) {
www_challenge("opensips.org", "auth");
};
}
...
</programlisting>
</example>
Expand Down Expand Up @@ -633,7 +638,7 @@ $var(username)="abc";
$var(password)="xyz";
if (!pv_proxy_authorize("")) {
proxy_challenge("", "auth"); # Realm will be autogenerated
};
}
...
</programlisting>
</example>
Expand Down
2 changes: 1 addition & 1 deletion modules/cachedb_local/doc/cachedb_local_admin.xml
Expand Up @@ -138,7 +138,7 @@ cache_store("local:group2", ...)
<section id="param_cache_collections" xreflabel="cache_collections">
<title><varname>cache_collections</varname> (string)</title>
<para>
Using this parameter collections(hash tables) and their sizes can be defined. Each
Using this parameter, collections(hash tables) and their sizes can be defined. Each
collection definition must be separated one from another using ';'. Default size
for a hash is 512. The size must be separated from the name of the collection using
'='.
Expand Down
18 changes: 9 additions & 9 deletions modules/cfgutils/doc/cfgutils_admin.xml
Expand Up @@ -502,8 +502,8 @@ ts_usec_delta($var(t1s), 300, 10, $var(t2ms), $var(result));
matches the current time, or a negative value otherwise.
</para>
<para>
For checking something else than the current time, the third parameter will
contain the UNIX timestamp of the time to check.
For checking some other Unix timestamp than the current one, the second
parameter will contain the intended timestamp to check.
</para>
<para>
The syntax of each field is identical to the corresponding field from
Expand Down Expand Up @@ -531,8 +531,8 @@ ts_usec_delta($var(t1s), 300, 10, $var(t2ms), $var(result));
</listitem>
<listitem>
<para><emphasis>timestamp (string, optional)</emphasis> - A
specific UNIX time to check. The function simply expects the
actual UNIX time here, there is no need to perform any timezone
specific Unix time to check. The function simply expects the
actual Unix time here, there is no need to perform any timezone
adjustments.
</para>
</listitem>
Expand Down Expand Up @@ -810,21 +810,21 @@ if (!release_dynamic_lock($avp(foo)) {
<function moreinfo="none">get_accurate_time(sec, usec, [str_sec_usec])</function>
</title>
<para>
Fetch the current UNIX time epoch with microsecond precision.
Fetch the current Unix time epoch with microsecond precision.
Optionally, print this value as a floating point number (3rd parameter).
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>sec (int)</emphasis> - the current UNIX timestamp (integer part)
<para><emphasis>sec (int)</emphasis> - the current Unix timestamp (integer part)
</para>
</listitem>
<listitem>
<para><emphasis>usec (int)</emphasis> - the current UNIX timestamp (decimal part)
<para><emphasis>usec (int)</emphasis> - the current Unix timestamp (decimal part)
</para>
</listitem>
<listitem>
<para><emphasis>str_sec_usec (string, optional)</emphasis> - the current UNIX
<para><emphasis>str_sec_usec (string, optional)</emphasis> - the current Unix
timestamp as a floating point number (6-digit precision)
</para>
</listitem>
Expand All @@ -838,7 +838,7 @@ if (!release_dynamic_lock($avp(foo)) {
<programlisting format="linespecific">
...
get_accurate_time($var(sec), $var(usec));
xlog("Current UNIX timestamp: $var(sec) s, $var(usec) us\n");
xlog("Current Unix timestamp: $var(sec) s, $var(usec) us\n");
...
</programlisting>
</example>
Expand Down
4 changes: 2 additions & 2 deletions modules/dispatcher/doc/dispatcher_admin.xml
Expand Up @@ -1248,8 +1248,8 @@ modparam("dispatcher", "max_freeswitch_weight", 1000)
<listitem>
<para>
<emphasis>max_res (int, optional)</emphasis> - signifies that only a maximum
number of destinations shall be included in the specified failover
AVP for failover. This allows having multiple destinations while
number of destinations shall be included in the specified failover AVP.
This allows having multiple destinations while
also preventing excessive failover attempts in case a number is
bound to fail globally.
</para>
Expand Down
4 changes: 2 additions & 2 deletions modules/drouting/doc/drouting_admin.xml
Expand Up @@ -1933,7 +1933,7 @@ if (goes_to_gw(1, , $var(gw_attrs), , "my_partition")) {

<section id="func_is_from_gw" xreflabel="is_from_gw()">
<title>
<function moreinfo="none">is_from_gw([type], [flag], [gw_attrs_pvar], [carrier_attrs_pvar], [partition])</function>
<function moreinfo="none">is_from_gw([type], [flags], [gw_attrs_pvar], [carrier_attrs_pvar], [partition])</function>
</title>
<para>
The function checks if the sender of the message (source IP + source
Expand Down Expand Up @@ -2052,7 +2052,7 @@ if (is_from_gw(, "c", , , "outbound")) {

<section id="func_dr_is_gw" xreflabel="dr_is_gw()">
<title>
<function moreinfo="none">dr_is_gw( sip_uri, [type], [flag], [gw_attrs_pvar], [carrier_attrs_pvar], [partition])</function>
<function moreinfo="none">dr_is_gw( sip_uri, [type], [flags], [gw_attrs_pvar], [carrier_attrs_pvar], [partition])</function>
</title>
<para>
The function checks if the SIP URI hostname part stored inside the
Expand Down
4 changes: 2 additions & 2 deletions modules/fraud_detection/doc/fraud_detection_admin.xml
Expand Up @@ -182,7 +182,7 @@ modparam("fraud_detection", "table_name", "my_fraud")
<title>Set <quote>rid_col</quote> parameter</title>
<programlisting format="linespecific">
...
modparam("fraud_detection", "rid_col", "theruleid"")
modparam("fraud_detection", "rid_col", "theruleid")
...
</programlisting>
</example>
Expand All @@ -207,7 +207,7 @@ modparam("fraud_detection", "rid_col", "theruleid"")
<title>Set <quote>pid_col</quote> parameter</title>
<programlisting format="linespecific">
...
modparam("fraud_detection", "pid_col", "profile"")
modparam("fraud_detection", "pid_col", "profile")
...
</programlisting>
</example>
Expand Down
2 changes: 1 addition & 1 deletion modules/mid_registrar/doc/mid_registrar_admin.xml
Expand Up @@ -495,7 +495,7 @@ modparam("mid_registrar", "received_param", "rcv")
<para>
An AVP specification. This AVP is evaluated during
<emphasis><xref linkend="func_mid_registrar_save"/></emphasis>:
if it holds a valid string, its content be appended to
if it holds a valid string, its content will be appended to
<emphasis>each</emphasis> new Contact URI built by the mid-registrar,
for the outgoing request.
</para>
Expand Down
2 changes: 1 addition & 1 deletion modules/permissions/doc/permissions_admin.xml
Expand Up @@ -616,7 +616,7 @@ modparam("permissions", "info_col", "info_col")
This argument represents the port to be matched.
Cached address table entry containing port value 0
matches any port.
Also, a "0" value for the argument can match any port in the
Also, a <emphasis>0</emphasis> value for the argument will match any port in the
address table.
</para>
</listitem>
Expand Down
2 changes: 1 addition & 1 deletion modules/prometheus/doc/prometheus_admin.xml
Expand Up @@ -281,7 +281,7 @@ modparam("prometheus", "statistics", "group: /^(.*)_(.*)$/\1:gateway=\"\2\"/")
module to listen on (default: <emphasis>0.0.0.0:8888</emphasis>).
</para>
<example>
<title>Prometheus Scarpe Config</title>
<title>Prometheus Scrape Config</title>
<programlisting format="linespecific">
<![CDATA[
scrape_configs:
Expand Down
4 changes: 2 additions & 2 deletions modules/rtpengine/doc/rtpengine_admin.xml
Expand Up @@ -323,7 +323,7 @@ modparam("rtpengine", "db_url",
Used when Database URL is provisioned.
</para>
<para>
Default value is <quote>rtpengines</quote>.
Default value is <quote>rtpengine</quote>.
</para>
<example>
<title>Set <varname>db_table</varname> parameter</title>
Expand Down Expand Up @@ -1405,7 +1405,7 @@ rtpengine_play_dtmf("0"); # send the 0 code upstream
</itemizedlist>
<para>
NOTE: if a &rtp; proxy is defined multiple times (in the same or
different set), all of its instances will be enabled/disbled IF no set ID is provided.
different set), all of its instances will be enabled/disabled IF no set ID is provided.
</para>
<example>
<title>
Expand Down
2 changes: 1 addition & 1 deletion modules/rtpproxy/doc/rtpproxy_admin.xml
Expand Up @@ -215,7 +215,7 @@
<title>Set <varname>rtpproxy_sock</varname> parameter</title>
<programlisting format="linespecific">
...
# single rtproxy with specific weight
# single rtpproxy with specific weight
modparam("rtpproxy", "rtpproxy_sock", "udp:localhost:22222=2")

# single rtpproxy with advertised address + weight
Expand Down
2 changes: 1 addition & 1 deletion modules/sipmsgops/doc/sipmsgops_admin.xml
Expand Up @@ -105,7 +105,7 @@ append_to_reply("Foo: $rm at $Ts\r\n");
<para>
Note: Headers which are added in main route cannot be removed in further routes
(e.g. failure routes). So, the idea is not to add there any headers that you
might want to remove later. To add headers temporarely use the branch route
might want to remove later. To add headers temporarily, use the branch route
because the changes you do there are per-branch.
</para>
<para>
Expand Down
2 changes: 1 addition & 1 deletion modules/stir_shaken/stir_shaken.c
Expand Up @@ -211,7 +211,7 @@ static int init_cert_validation(void)

if (ca_list || ca_dir) {
if (X509_STORE_load_locations(store, ca_list, ca_dir) != 1) {
LM_ERR("Failed to load trustefd CAs\n");
LM_ERR("Failed to load trusted CAs\n");
return -1;
}
if (X509_STORE_set_default_paths(store) != 1) {
Expand Down
5 changes: 2 additions & 3 deletions modules/usrloc/doc/usrloc_admin.xml
Expand Up @@ -1352,8 +1352,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
can perform contact pinging using one of at most two possible
heuristics:
can perform contact pinging using one of two possible heuristics:
<itemizedlist>
<listitem>
<para><emphasis role='bold'>"ownership"</emphasis> - this instance
Expand All @@ -1362,7 +1361,7 @@ modparam("usrloc", "latency_event_min_us_delta", 300000)
a contact, a node will keep sending pings to that contact as
long as it owns the respective tag. If no shared tag has been
specified for a given contact, the default is to assume
permanent ownership of the contact and always ping it.
permanent ownership of the contact and ping it upon request.
</para>
</listitem>
<listitem>
Expand Down

0 comments on commit 7cdbc99

Please sign in to comment.