25
1
mirror of https://github.com/processone/ejabberd.git synced 2024-11-24 16:23:40 +01:00

Remove ... in example configuration: it is assumed and reduces verbosity

This commit is contained in:
Badlop 2024-03-29 16:09:50 +01:00
parent 6e5895ce45
commit 345af5a535
14 changed files with 14 additions and 53 deletions

View File

@ -129,7 +129,6 @@ mod_doc() ->
" server: sat-pubsub.example.org", " server: sat-pubsub.example.org",
"", "",
"modules:", "modules:",
" ...",
" mod_delegation:", " mod_delegation:",
" namespaces:", " namespaces:",
" urn:xmpp:mam:1:", " urn:xmpp:mam:1:",

View File

@ -561,18 +561,13 @@ mod_doc() ->
"content type 'ogg' is defined, 'png' is redefined, and 'jpg' " "content type 'ogg' is defined, 'png' is redefined, and 'jpg' "
"definition is deleted:"), "definition is deleted:"),
["listen:", ["listen:",
" ...",
" -", " -",
" port: 5280", " port: 5280",
" module: ejabberd_http", " module: ejabberd_http",
" request_handlers:", " request_handlers:",
" ...",
" /pub/content: mod_http_fileserver", " /pub/content: mod_http_fileserver",
" ...",
" ...",
"", "",
"modules:", "modules:",
" ...",
" mod_http_fileserver:", " mod_http_fileserver:",
" docroot: /var/www", " docroot: /var/www",
" accesslog: /var/log/ejabberd/access.log", " accesslog: /var/log/ejabberd/access.log",
@ -585,5 +580,4 @@ mod_doc() ->
" content_types:", " content_types:",
" .ogg: audio/ogg", " .ogg: audio/ogg",
" .png: image/png", " .png: image/png",
" default_content_type: text/html", " default_content_type: text/html"]}]}.
" ..."]}]}.

View File

@ -384,23 +384,17 @@ mod_doc() ->
" street: Elm Street"]}]}}], " street: Elm Street"]}]}}],
example => example =>
["listen:", ["listen:",
" ...",
" -", " -",
" port: 5443", " port: 5443",
" module: ejabberd_http", " module: ejabberd_http",
" tls: true", " tls: true",
" request_handlers:", " request_handlers:",
" ...",
" /upload: mod_http_upload", " /upload: mod_http_upload",
" ...",
" ...",
"", "",
"modules:", "modules:",
" ...",
" mod_http_upload:", " mod_http_upload:",
" docroot: /ejabberd/upload", " docroot: /ejabberd/upload",
" put_url: \"https://@HOST@:5443/upload\"", " put_url: \"https://@HOST@:5443/upload\""]}.
" ..."]}.
-spec depends(binary(), gen_mod:opts()) -> [{module(), hard | soft}]. -spec depends(binary(), gen_mod:opts()) -> [{module(), hard | soft}].
depends(_Host, _Opts) -> depends(_Host, _Opts) ->

View File

@ -134,19 +134,15 @@ mod_doc() ->
"to use the quota feature. You can stick to the default names " "to use the quota feature. You can stick to the default names "
"and just specify access rules such as those in this example:"), "and just specify access rules such as those in this example:"),
["shaper_rules:", ["shaper_rules:",
" ...",
" soft_upload_quota:", " soft_upload_quota:",
" 1000: all # MiB", " 1000: all # MiB",
" hard_upload_quota:", " hard_upload_quota:",
" 1100: all # MiB", " 1100: all # MiB",
" ...",
"", "",
"modules:", "modules:",
" ...",
" mod_http_upload: {}", " mod_http_upload: {}",
" mod_http_upload_quota:", " mod_http_upload_quota:",
" max_days: 100", " max_days: 100"]}]}.
" ..."]}]}.
-spec depends(binary(), gen_mod:opts()) -> [{module(), hard | soft}]. -spec depends(binary(), gen_mod:opts()) -> [{module(), hard | soft}].
depends(_Host, _Opts) -> depends(_Host, _Opts) ->

View File

@ -178,7 +178,6 @@ mod_doc() ->
?T("It is available since ejabberd 23.01.")], ?T("It is available since ejabberd 23.01.")],
example => example =>
["modules:", ["modules:",
" ...",
" mod_mqtt_bridge:", " mod_mqtt_bridge:",
" servers:", " servers:",
" \"mqtt://server.com\":", " \"mqtt://server.com\":",
@ -189,8 +188,7 @@ mod_doc() ->
" \"remoteB\": \"localB\" # changes to 'remoteB' on remote server will be stored as 'localB' on local server", " \"remoteB\": \"localB\" # changes to 'remoteB' on remote server will be stored as 'localB' on local server",
" authentication:", " authentication:",
" certfile: \"/etc/ejabberd/mqtt_server.pem\"", " certfile: \"/etc/ejabberd/mqtt_server.pem\"",
" replication_user: \"mqtt@xmpp.server.com\"", " replication_user: \"mqtt@xmpp.server.com\""],
" ..."],
opts => opts =>
[{servers, [{servers,
#{value => "{ServerUrl: {publish: [TopicPairs], subscribe: [TopicPairs], authentication: [AuthInfo]}}", #{value => "{ServerUrl: {publish: [TopicPairs], subscribe: [TopicPairs], authentication: [AuthInfo]}}",

View File

@ -352,9 +352,7 @@ mod_doc() ->
"The default value is 'none'.")}}], "The default value is 'none'.")}}],
example => example =>
["modules:", ["modules:",
" ...",
" mod_ping:", " mod_ping:",
" send_pings: true", " send_pings: true",
" ping_interval: 4 min", " ping_interval: 4 min",
" timeout_action: kill", " timeout_action: kill"]}.
" ..."]}.

View File

@ -150,8 +150,6 @@ mod_doc() ->
?T("The time interval. The default value is '1' minute.")}}], ?T("The time interval. The default value is '1' minute.")}}],
example => example =>
["modules:", ["modules:",
" ...",
" mod_pres_counter:", " mod_pres_counter:",
" count: 5", " count: 5",
" interval: 30 secs", " interval: 30 secs"]}.
" ..."]}.

View File

@ -163,15 +163,13 @@ mod_doc() ->
"The default value is 'none'.")}}]}], "The default value is 'none'.")}}]}],
example => example =>
["modules:", ["modules:",
" ...",
" mod_privilege:", " mod_privilege:",
" roster:", " roster:",
" get: all", " get: all",
" presence:", " presence:",
" managed_entity: all", " managed_entity: all",
" message:", " message:",
" outgoing: all", " outgoing: all"]}.
" ..."]}.
depends(_, _) -> depends(_, _) ->
[]. [].

View File

@ -274,7 +274,6 @@ mod_doc() ->
" proxyrate: 10240", " proxyrate: 10240",
"", "",
"modules:", "modules:",
" ...",
" mod_proxy65:", " mod_proxy65:",
" host: proxy1.example.org", " host: proxy1.example.org",
" name: \"File Transfer Proxy\"", " name: \"File Transfer Proxy\"",
@ -284,5 +283,4 @@ mod_doc() ->
" access: proxy65_access", " access: proxy65_access",
" shaper: proxy65_shaper", " shaper: proxy65_shaper",
" recbuf: 10240", " recbuf: 10240",
" sndbuf: 10240", " sndbuf: 10240"]}.
" ..."]}.

View File

@ -4524,7 +4524,6 @@ mod_doc() ->
[{?T("Example of configuration that uses flat nodes as default, " [{?T("Example of configuration that uses flat nodes as default, "
"and allows use of flat, hometree and pep nodes:"), "and allows use of flat, hometree and pep nodes:"),
["modules:", ["modules:",
" ...",
" mod_pubsub:", " mod_pubsub:",
" access_createnode: pubsub_createnode", " access_createnode: pubsub_createnode",
" max_subscriptions_node: 100", " max_subscriptions_node: 100",
@ -4534,14 +4533,12 @@ mod_doc() ->
" max_items: 4", " max_items: 4",
" plugins:", " plugins:",
" - flat", " - flat",
" - pep", " - pep"]},
" ..."]},
{?T("Using relational database requires using mod_pubsub with " {?T("Using relational database requires using mod_pubsub with "
"db_type 'sql'. Only flat, hometree and pep plugins supports " "db_type 'sql'. Only flat, hometree and pep plugins supports "
"SQL. The following example shows previous configuration " "SQL. The following example shows previous configuration "
"with SQL usage:"), "with SQL usage:"),
["modules:", ["modules:",
" ...",
" mod_pubsub:", " mod_pubsub:",
" db_type: sql", " db_type: sql",
" access_createnode: pubsub_createnode", " access_createnode: pubsub_createnode",
@ -4549,6 +4546,5 @@ mod_doc() ->
" last_item_cache: false", " last_item_cache: false",
" plugins:", " plugins:",
" - flat", " - flat",
" - pep", " - pep"]}
" ..."]}
]}. ]}.

View File

@ -1410,8 +1410,6 @@ mod_doc() ->
?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}], ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}],
example => example =>
["modules:", ["modules:",
" ...",
" mod_roster:", " mod_roster:",
" versioning: true", " versioning: true",
" store_current_id: false", " store_current_id: false"]}.
" ..."]}.

View File

@ -93,14 +93,12 @@ mod_doc() ->
"is 'all'.")}}], "is 'all'.")}}],
example => example =>
["modules:", ["modules:",
" ...",
" mod_s2s_dialback:", " mod_s2s_dialback:",
" access:", " access:",
" allow:", " allow:",
" server: legacy.domain.tld", " server: legacy.domain.tld",
" server: invalid-cert.example.org", " server: invalid-cert.example.org",
" deny: all", " deny: all"]}.
" ..."]}.
s2s_in_features(Acc, _) -> s2s_in_features(Acc, _) ->
[#db_feature{errors = true}|Acc]. [#db_feature{errors = true}|Acc].

View File

@ -92,9 +92,7 @@ mod_doc() ->
"to which stanzas will be forwarded.")}}], "to which stanzas will be forwarded.")}}],
example => example =>
["modules:", ["modules:",
" ...",
" mod_service_log:", " mod_service_log:",
" loggers:", " loggers:",
" - xmpp-server.tld", " - xmpp-server.tld",
" - component.domain.tld", " - component.domain.tld"]}.
" ..."]}.

View File

@ -437,7 +437,6 @@ mod_doc() ->
"cannot omit \"port\" or \"scheme\").")}}], "cannot omit \"port\" or \"scheme\").")}}],
example => example =>
["modules:", ["modules:",
" ...",
" mod_sip:", " mod_sip:",
" always_record_route: false", " always_record_route: false",
" record_route: \"sip:example.com;lr\"", " record_route: \"sip:example.com;lr\"",
@ -449,7 +448,6 @@ mod_doc() ->
" via:", " via:",
" - tls://sip-tls.example.com:5061", " - tls://sip-tls.example.com:5061",
" - tcp://sip-tcp.example.com:5060", " - tcp://sip-tcp.example.com:5060",
" - udp://sip-udp.example.com:5060", " - udp://sip-udp.example.com:5060"]}.
" ..."]}.
-endif. -endif.