summaryrefslogtreecommitdiff
path: root/lib/inets
diff options
context:
space:
mode:
authorLukas Larsson <lukas@erlang.org>2020-03-11 10:11:22 +0100
committerLukas Larsson <lukas@erlang.org>2020-03-27 11:02:23 +0100
commit0799c2b0e9ae5fce18d092a153fff884d1dd3912 (patch)
treec7c72465bd01591a9163e5ad17cea92bf3be75ec /lib/inets
parent6c6fe8e774f7cde6d158b450fd1ad6c3129dc22e (diff)
downloaderlang-0799c2b0e9ae5fce18d092a153fff884d1dd3912.tar.gz
otp: Convert all <seealso> to more specific variants
We add `seemfa`, `seeerl`, `seetype`, `seeapp`, `seecom`, `seecref` , `seefile` and `seeguide` in order to make it easier to reason about what each link points to without examining the target. This information will then be embedded in the EEP-48 chunks for usage by other tools. The tool used can be found here: https://gist.github.com/garazdawi/68527d92ae5b37c8f129bfbdfffdfa68
Diffstat (limited to 'lib/inets')
-rw-r--r--lib/inets/doc/src/http_client.xml2
-rw-r--r--lib/inets/doc/src/http_server.xml44
-rw-r--r--lib/inets/doc/src/http_uri.xml10
-rw-r--r--lib/inets/doc/src/httpc.xml34
-rw-r--r--lib/inets/doc/src/httpd.xml34
-rw-r--r--lib/inets/doc/src/httpd_custom_api.xml2
-rw-r--r--lib/inets/doc/src/httpd_socket.xml2
-rw-r--r--lib/inets/doc/src/httpd_util.xml2
-rw-r--r--lib/inets/doc/src/inets.xml8
-rw-r--r--lib/inets/doc/src/mod_alias.xml14
-rw-r--r--lib/inets/doc/src/mod_auth.xml4
-rw-r--r--lib/inets/doc/src/mod_esi.xml8
-rw-r--r--lib/inets/doc/src/notes.xml82
-rw-r--r--lib/inets/doc/src/notes_history.xml2
14 files changed, 124 insertions, 124 deletions
diff --git a/lib/inets/doc/src/http_client.xml b/lib/inets/doc/src/http_client.xml
index c31a47f4f4..ad11ea2a6c 100644
--- a/lib/inets/doc/src/http_client.xml
+++ b/lib/inets/doc/src/http_client.xml
@@ -54,7 +54,7 @@
<pre>
[{inets, [{services, [{httpc, PropertyList}]}]}]</pre>
<p>For valid properties, see
- <seealso marker="httpc">httpc(3)</seealso>. </p>
+ <seeerl marker="httpc">httpc(3)</seeerl>. </p>
</section>
<section>
diff --git a/lib/inets/doc/src/http_server.xml b/lib/inets/doc/src/http_server.xml
index 8fe8bb00fb..65d2fb0fa5 100644
--- a/lib/inets/doc/src/http_server.xml
+++ b/lib/inets/doc/src/http_server.xml
@@ -74,7 +74,7 @@
<p>The server is configured using an Erlang property list.
For the available properties, see
- <seealso marker="httpd">httpd(3)</seealso>.
+ <seeerl marker="httpd">httpd(3)</seeerl>.
</p>
<p>The available configuration properties are as follows:</p>
@@ -230,7 +230,7 @@ http://your.server.org/***/Module[:/]Function(?QueryString|/PathInfo)</code>
function with arity two is only kept for
backwards compatibility reasons.
For implementation details of the ESI callback function,
- see <seealso marker="mod_esi">mod_esi(3)</seealso>.</p>
+ see <seeerl marker="mod_esi">mod_esi(3)</seeerl>.</p>
</section>
</section>
@@ -291,8 +291,8 @@ http://your.server.org/***/Module[:/]Function(?QueryString|/PathInfo)</code>
related steps, are considered server core functionality and are
not implemented using the Erlang web server API. A description of
functionality implemented by the Erlang webserver API is described
- in <seealso marker="#Inets_Web_Server_Modules">Section
- Inets Web Server Modules</seealso>.</p>
+ in <seeguide marker="#Inets_Web_Server_Modules">Section
+ Inets Web Server Modules</seeguide>.</p>
<p>A module can use data generated by previous modules in the
Erlang webserver API module sequence or generate data to be used
@@ -319,7 +319,7 @@ http://your.server.org/***/Module[:/]Function(?QueryString|/PathInfo)</code>
</list>
<p>The latter functions are needed only when new config
directives are to be introduced. For details, see
- <seealso marker="httpd">httpd(3)</seealso>.</p>
+ <seeerl marker="httpd">httpd(3)</seeerl>.</p>
</section>
</section>
@@ -344,7 +344,7 @@ http://your.server.org/***/Module[:/]Function(?QueryString|/PathInfo)</code>
<p>Uses the following Erlang Web Server API interaction data:
</p>
<list type="bulleted">
- <item><c>real_name</c> - from <seealso marker="mod_alias">mod_alias</seealso>.</item>
+ <item><c>real_name</c> - from <seeerl marker="mod_alias">mod_alias</seeerl>.</item>
</list>
<p>Exports the following Erlang Web Server API interaction data, if possible:
</p>
@@ -356,7 +356,7 @@ http://your.server.org/***/Module[:/]Function(?QueryString|/PathInfo)</code>
<section>
<title>mod_alias - URL Aliasing</title>
- <p>The <seealso marker="mod_alias">mod_alias</seealso>
+ <p>The <seeerl marker="mod_alias">mod_alias</seeerl>
module makes it possible to map different parts of the
host file system into the document tree, that is, creates aliases and
redirections.</p>
@@ -365,19 +365,19 @@ http://your.server.org/***/Module[:/]Function(?QueryString|/PathInfo)</code>
<taglist>
<tag><c>{real_name, PathData}</c></tag>
<item><c>PathData</c> is the argument used for API function
- <seealso marker="mod_alias#path/3">mod_alias:path/3</seealso>.</item>
+ <seemfa marker="mod_alias#path/3">mod_alias:path/3</seemfa>.</item>
</taglist>
</section>
<section>
<title>mod_auth - User Authentication</title>
- <p>The <seealso marker="mod_auth">mod_auth(3)</seealso>
+ <p>The <seeerl marker="mod_auth">mod_auth(3)</seeerl>
module provides for basic user authentication using
textual files, Dets databases as well as Mnesia databases.</p>
<p>Uses the following Erlang Web Server API interaction data:
</p>
<list type="bulleted">
- <item><c>real_name</c> - from <seealso marker="mod_alias">mod_alias</seealso></item>
+ <item><c>real_name</c> - from <seeerl marker="mod_alias">mod_alias</seeerl></item>
</list>
<p>Exports the following Erlang Web Server API interaction data:
</p>
@@ -432,11 +432,11 @@ start() ->
Then it starts Mnesia and creates the tables. The first argument
is the name of the tables, the second argument is a list of options of
how to create the table, see
- <seealso marker="mnesia:mnesia"><c>mnesia(3)</c></seealso>, documentation for
+ <seeerl marker="mnesia:mnesia"><c>mnesia(3)</c></seeerl>, documentation for
more information. As the implementation of the <c>mod_auth_mnesia</c>
saves one row for each user, the type must be <c>bag</c>.
When the schema and the tables are created, function
- <seealso marker="mnesia:mnesia#start/0">mnesia:start/0</seealso>
+ <seemfa marker="mnesia:mnesia#start/0">mnesia:start/0</seemfa>
is used to start Mnesia and
waits for the tables to be loaded. Mnesia uses the
directory specified as <c>mnesia_dir</c> at startup if specified,
@@ -465,7 +465,7 @@ start() ->
<p>Uses the following Erlang Web Server API interaction data:
</p>
<list type="bulleted">
- <item><c>real_name</c> - from <seealso marker="mod_alias">mod_alias</seealso></item>
+ <item><c>real_name</c> - from <seeerl marker="mod_alias">mod_alias</seeerl></item>
</list>
<p>Exports the following Erlang Web Server API interaction data:
</p>
@@ -479,7 +479,7 @@ start() ->
<section>
<title>mod_disk_log - Logging Using Disk_Log.</title>
<p>Standard logging using the "Common Logfile Format" and
- <seealso marker="kernel:disk_log">disk_log(3)</seealso>.</p>
+ <seeerl marker="kernel:disk_log">disk_log(3)</seeerl>.</p>
<p>Uses the following Erlang Web Server API interaction data:
</p>
<list type="bulleted">
@@ -489,7 +489,7 @@ start() ->
<section>
<title>mod_esi - Erlang Server Interface</title>
- <p>The <seealso marker="mod_esi">mod_esi(3)</seealso>
+ <p>The <seeerl marker="mod_esi">mod_esi(3)</seeerl>
module implements the Erlang Server Interface (ESI) providing a
tight and efficient interface to the execution of Erlang functions.</p>
<p>Uses the following Erlang web server API interaction data:
@@ -513,7 +513,7 @@ start() ->
<p>Uses the following Erlang web server API interaction data:
</p>
<list type="bulleted">
- <item><c>real_name</c> - from <seealso marker="mod_alias">mod_alias</seealso></item>
+ <item><c>real_name</c> - from <seeerl marker="mod_alias">mod_alias</seeerl></item>
</list>
</section>
@@ -525,7 +525,7 @@ start() ->
<p>Uses the following Erlang Web Server API interaction data:
</p>
<list type="bulleted">
- <item><c>real_name</c> - from <seealso marker="mod_alias">mod_alias</seealso></item>
+ <item><c>real_name</c> - from <seeerl marker="mod_alias">mod_alias</seeerl></item>
</list>
</section>
@@ -551,7 +551,7 @@ start() ->
<p>Uses the following Erlang Web Server API interaction data:
</p>
<list type="bulleted">
- <item><c>real_name</c> - from <seealso marker="mod_alias">mod_alias</seealso></item>
+ <item><c>real_name</c> - from <seeerl marker="mod_alias">mod_alias</seeerl></item>
</list>
</section>
@@ -565,7 +565,7 @@ start() ->
<p>If a client sends more than one of the header fields that
restricts the servers right to respond, the standard does not
specify how this is to be handled.
- <seealso marker="httpd">httpd(3)</seealso> controls each
+ <seeerl marker="httpd">httpd(3)</seeerl> controls each
field in the following order and if one of the fields does not
match the current state, the request is rejected with a proper
response:</p>
@@ -577,7 +577,7 @@ start() ->
<p>Uses the following Erlang Web Server API interaction data:
</p>
<list type="bulleted">
- <item><c>real_name</c> - from <seealso marker="mod_alias">mod_alias</seealso></item>
+ <item><c>real_name</c> - from <seeerl marker="mod_alias">mod_alias</seeerl></item>
</list>
<p>Exports the following Erlang Web Server API interaction data:
</p>
@@ -591,9 +591,9 @@ start() ->
<section>
<title>mod_security - Security Filter</title>
- <p>The <seealso marker="mod_security">mod_security</seealso>
+ <p>The <seeerl marker="mod_security">mod_security</seeerl>
module serves as a filter for authenticated requests
- handled in <seealso marker="mod_auth">mod_auth(3)</seealso>.
+ handled in <seeerl marker="mod_auth">mod_auth(3)</seeerl>.
It provides a possibility to restrict users from
access for a specified amount of time if they fail to
authenticate several times. It logs failed authentication as
diff --git a/lib/inets/doc/src/http_uri.xml b/lib/inets/doc/src/http_uri.xml
index 7fc524ff7f..3d6c20bbfb 100644
--- a/lib/inets/doc/src/http_uri.xml
+++ b/lib/inets/doc/src/http_uri.xml
@@ -35,7 +35,7 @@
<description>
<p>This module is deprecated since OTP 23.
- Use the module <seealso marker="stdlib:uri_string">uri_string</seealso> to properly handle URIs,
+ Use the module <seeerl marker="stdlib:uri_string">uri_string</seeerl> to properly handle URIs,
this is the recommend module since OTP 21.
</p>
</description>
@@ -134,7 +134,7 @@
<desc>
<p>Parses a URI. If no scheme defaults
are provided, the value of the
- <seealso marker="#scheme_defaults">scheme_defaults</seealso>
+ <seeerl marker="#scheme_defaults">scheme_defaults</seeerl>
function is used.</p>
<p>When parsing a URI with an unknown scheme (that is,
@@ -188,9 +188,9 @@ fun(SchemeStr :: string() | binary()) ->
<section>
<title>SEE ALSO</title>
<p><url href="http://www.ietf.org/rfc/rfc2616.txt">RFC 2616</url>,
- <seealso marker="inets">inets(3)</seealso>,
- <seealso marker="kernel:gen_tcp">gen_tcp(3)</seealso>,
- <seealso marker="ssl:ssl">ssl(3)</seealso>
+ <seeerl marker="inets">inets(3)</seeerl>,
+ <seeerl marker="kernel:gen_tcp">gen_tcp(3)</seeerl>,
+ <seeerl marker="ssl:ssl">ssl(3)</seeerl>
</p>
</section>
-->
diff --git a/lib/inets/doc/src/httpc.xml b/lib/inets/doc/src/httpc.xml
index 82d9d544fb..2c705a47b5 100644
--- a/lib/inets/doc/src/httpc.xml
+++ b/lib/inets/doc/src/httpc.xml
@@ -57,8 +57,8 @@
pipelining are used. That is, the client always waits for
the previous response before sending the next request.</p>
</note>
- <p>Some examples are provided in the <seealso
- marker="http_client">Inets User's Guide</seealso>.</p>
+ <p>Some examples are provided in the <seeguide
+ marker="http_client">Inets User's Guide</seeguide>.</p>
</description>
<section>
@@ -72,10 +72,10 @@
<p><c>profile() = atom()</c></p>
<p><c>path() = string()</c> representing a file path or directory path</p>
<p><c>ip_address()</c> = See the
- <seealso marker="kernel:inet">inet(3)</seealso> manual page in Kernel.</p>
+ <seeerl marker="kernel:inet">inet(3)</seeerl> manual page in Kernel.</p>
<p><c>socket_opt()</c> = See the options used by
- <seealso marker="kernel:gen_tcp">gen_tcp(3)</seealso> <c>gen_tcp(3)</c> and
- <seealso marker="ssl:ssl">ssl(3)</seealso> connect(s)</p>
+ <seeerl marker="kernel:gen_tcp">gen_tcp(3)</seeerl> <c>gen_tcp(3)</c> and
+ <seeerl marker="ssl:ssl">ssl(3)</seeerl> connect(s)</p>
</section>
@@ -120,7 +120,7 @@
<section>
<title>SSL DATA TYPES</title>
- <p>See <seealso marker="ssl:ssl">ssl(3)</seealso> for information
+ <p>See <seeerl marker="ssl:ssl">ssl(3)</seeerl> for information
about <c>SSL</c> options (<c>ssloptions()</c>). </p>
</section>
@@ -131,12 +131,12 @@
application or started dynamically in runtime by calling the
<c>Inets</c> application API <c>inets:start(httpc, ServiceConfig)</c>
or <c>inets:start(httpc, ServiceConfig, How)</c>,
- see <seealso marker="inets">inets(3)</seealso>.
+ see <seeerl marker="inets">inets(3)</seeerl>.
The configuration options are as follows:</p>
<taglist>
<tag>{profile, profile()}</tag>
<item><p>Name of the profile, see
- <seealso marker="#DATA_TYPES">DATA TYPES</seealso>.
+ <seeerl marker="#DATA_TYPES">DATA TYPES</seeerl>.
This option is mandatory.</p></item>
<tag>{data_dir, path()}</tag>
<item><p>Directory where the profile
@@ -188,7 +188,7 @@
<p>Option <c>ipv6_host_with_bracket</c> deals with how to
parse IPv6 addresses. For details,
see argument <c>Options</c> of
- <seealso marker="#request/4">request/[4,5]</seealso>.</p>
+ <seemfa marker="#request/4">request/[4,5]</seemfa>.</p>
</desc>
</func>
@@ -343,7 +343,7 @@
<tag><c><![CDATA[ssl]]></c></tag>
<item>
<p>This is the <c>SSL/TLS</c> connectin configuration option.</p>
- <p>Defaults to <c>[]</c>. See <seealso marker="ssl:ssl">ssl:connect/[2,3,4]</seealso> for available options.</p>
+ <p>Defaults to <c>[]</c>. See <seeerl marker="ssl:ssl">ssl:connect/[2,3,4]</seeerl> for available options.</p>
</item>
<tag><c><![CDATA[autoredirect]]></c></tag>
@@ -443,7 +443,7 @@
<item>
<p>Socket options to be used for this request.</p>
<p>Overrides any value set by function
- <seealso marker="#set_options/1">set_options</seealso>.</p>
+ <seemfa marker="#set_options/1">set_options</seemfa>.</p>
<p>The validity of the options is <em>not</em> checked by
the HTTP client they are assumed to be correct and passed
on to ssl application and inet driver, which may reject
@@ -459,7 +459,7 @@
</note>
<p>By default the socket options set by function
- <seealso marker="#set_options/1">set_options/[1,2]</seealso>
+ <seemfa marker="#set_options/1">set_options/[1,2]</seemfa>
are used when establishing a connection.</p>
</item>
@@ -587,11 +587,11 @@
<v>IpAddress = ip_address()</v>
<d>If the host has several network interfaces, this option specifies
which one to use.
- See <seealso marker="kernel:gen_tcp#connect">gen_tcp:connect/3,4</seealso>
+ See <seeerl marker="kernel:gen_tcp#connect">gen_tcp:connect/3,4</seeerl>
for details.</d>
<v>Port = integer()</v>
<d>Local port number to use.
- See <seealso marker="kernel:gen_tcp#connect">gen_tcp:connect/3,4</seealso>
+ See <seeerl marker="kernel:gen_tcp#connect">gen_tcp:connect/3,4</seeerl>
for details.</d>
<v>socket_opts() = [socket_opt()]</v>
<d>The options are appended to the socket options used by the
@@ -721,9 +721,9 @@
<section>
<title>SEE ALSO</title>
<p><url href="http://www.ietf.org/rfc/rfc2616.txt">RFC 2616</url>,
- <seealso marker="inets">inets(3)</seealso>,
- <seealso marker="kernel:gen_tcp">gen_tcp(3)</seealso>,
- <seealso marker="ssl:ssl">ssl(3)</seealso>
+ <seeerl marker="inets">inets(3)</seeerl>,
+ <seeerl marker="kernel:gen_tcp">gen_tcp(3)</seeerl>,
+ <seeerl marker="ssl:ssl">ssl(3)</seeerl>
</p>
</section>
diff --git a/lib/inets/doc/src/httpd.xml b/lib/inets/doc/src/httpd.xml
index 8d3768420c..366ff4905e 100644
--- a/lib/inets/doc/src/httpd.xml
+++ b/lib/inets/doc/src/httpd.xml
@@ -61,7 +61,7 @@
application, or dynamically in runtime by calling the
<c>Inets</c> application API <c>inets:start(httpd, ServiceConfig)</c> or
<c>inets:start(httpd, ServiceConfig, How)</c>,
- see <seealso marker="inets">inets(3)</seealso>.
+ see <seeerl marker="inets">inets(3)</seeerl>.
The configuration options, also called
properties, are as follows:</p>
@@ -130,24 +130,24 @@
<tag><marker id="profile"></marker>{profile, atom()}</tag>
<item>
- <p>Used together with <seealso marker="#prop_bind_address"><c>bind_address</c></seealso>
- and <seealso marker="#prop_port"><c>port</c></seealso> to uniquely identify
+ <p>Used together with <seeerl marker="#prop_bind_address"><c>bind_address</c></seeerl>
+ and <seeerl marker="#prop_port"><c>port</c></seeerl> to uniquely identify
a HTTP server. This can be useful in a virtualized environment,
where there can
be more that one server that has the same bind_address and port.
If this property is not explicitly set, it is assumed that the
- <seealso marker="#prop_bind_address"><c>bind_address</c></seealso> and
- <seealso marker="#prop_port"><c>port</c></seealso>uniquely identifies the HTTP server.
+ <seeerl marker="#prop_bind_address"><c>bind_address</c></seeerl> and
+ <seeerl marker="#prop_port"><c>port</c></seeerl>uniquely identifies the HTTP server.
</p>
</item>
<tag><marker id="prop_socket_type"></marker>{socket_type, ip_comm | {ip_comm, Config::proplist()} | {essl, Config::proplist()}}</tag>
<item>
<p>For <c>ip_comm</c> configuration options, see
- <seealso marker="kernel:gen_tcp#listen/2">gen_tcp:listen/2</seealso>, some options
+ <seemfa marker="kernel:gen_tcp#listen/2">gen_tcp:listen/2</seemfa>, some options
that are used internally by httpd cannot be set.</p>
<p>For <c>SSL</c> configuration options, see
- <seealso marker="ssl:ssl#listen/2">ssl:listen/2</seealso>.</p>
+ <seemfa marker="ssl:ssl#listen/2">ssl:listen/2</seemfa>.</p>
<p>Default is <c>ip_comm</c>.</p>
</item>
@@ -176,7 +176,7 @@
mod_disk_log]</c>.
Notice that some <c>mod</c>-modules are dependent on
others, so the order cannot be entirely arbitrary. See the
- <seealso marker="http_server">Inets Web Server Modules</seealso> in the
+ <seeguide marker="http_server">Inets Web Server Modules</seeguide> in the
User's Guide for details.</p>
</item>
</taglist>
@@ -188,7 +188,7 @@
<tag><marker id="prop_customize"></marker>{customize, atom()}</tag>
<item>
<p>A callback module to customize the inets HTTP servers behaviour
- see <seealso marker="httpd_custom_api"> httpd_custom_api</seealso> </p>
+ see <seeerl marker="httpd_custom_api"> httpd_custom_api</seeerl> </p>
</item>
<tag><marker id="prop_disable_chunked_encoding"></marker>{disable_chunked_transfer_encoding_send, boolean()}</tag>
@@ -259,7 +259,7 @@
<p>Enforces chunking of a HTTP PUT or POST body data to be deliverd
to the mod_esi callback. Note this is not supported for mod_cgi.
Default is no limit e.i the whole body is deliverd as one entity, which could
- be very memory consuming. <seealso marker="mod_esi">mod_esi(3)</seealso>.
+ be very memory consuming. <seeerl marker="mod_esi">mod_esi(3)</seeerl>.
</p>
</item>
@@ -334,9 +334,9 @@ text/plain asc txt</pre>
<taglist>
<tag><c>{error, ServerID::atom()}</c></tag>
<item> <p>Produces
- <seealso marker="kernel:logger#type-log_event">logger events</seealso>
- on logger <seealso marker="kernel:logger#type-level">level error</seealso>
- under the hierarchical logger <seealso marker="kernel:logger#type-log_event">domain:</seealso> <c>[otp, inets, httpd, ServerID, error]</c>
+ <seetype marker="kernel:logger#log_event">logger events</seetype>
+ on logger <seetype marker="kernel:logger#level">level error</seetype>
+ under the hierarchical logger <seetype marker="kernel:logger#log_event">domain:</seetype> <c>[otp, inets, httpd, ServerID, error]</c>
The built in logger formatting
function produces log entries from the
error reports:</p>
@@ -906,7 +906,7 @@ Transport: TLS
<note><p>Pid is the pid returned from <c>inets:start/[2,3]</c>.
Can also be retrieved form <c>inets:services/0</c> and
<c>inets:services_info/0</c>,
- see <seealso marker="inets">inets(3)</seealso>.
+ see <seeerl marker="inets">inets(3)</seeerl>.
</p></note>
</desc>
</func>
@@ -1170,7 +1170,7 @@ Transport: TLS
</type>
<desc>
<p><c>parse_query/1</c> parses incoming data to <c>erl</c> and
- <c>eval</c> scripts (see <seealso marker="mod_esi">mod_esi(3)</seealso>)
+ <c>eval</c> scripts (see <seeerl marker="mod_esi">mod_esi(3)</seeerl>)
as defined in the standard
URL format, that is, '+' becomes 'space' and decoding of
hexadecimal characters (<c>%xx</c>).</p>
@@ -1181,8 +1181,8 @@ Transport: TLS
<section>
<title>SEE ALSO</title>
<p><url href="http://www.ietf.org/rfc/rfc2616.txt">RFC 2616</url>,
- <seealso marker="inets">inets(3)</seealso>,
- <seealso marker="ssl:ssl">ssl(3)</seealso>
+ <seeerl marker="inets">inets(3)</seeerl>,
+ <seeerl marker="ssl:ssl">ssl(3)</seeerl>
</p>
</section>
diff --git a/lib/inets/doc/src/httpd_custom_api.xml b/lib/inets/doc/src/httpd_custom_api.xml
index 2c0f92ff83..c904f9ab41 100644
--- a/lib/inets/doc/src/httpd_custom_api.xml
+++ b/lib/inets/doc/src/httpd_custom_api.xml
@@ -29,7 +29,7 @@
<modulesummary>Behaviour with optional callbacks to customize the inets HTTP server.</modulesummary>
<description>
<p> The module implementing this behaviour shall be supplied to to the servers
- configuration with the option <seealso marker="httpd#prop_customize"> customize</seealso></p>
+ configuration with the option <seeerl marker="httpd#prop_customize"> customize</seeerl></p>
</description>
<funcs>
diff --git a/lib/inets/doc/src/httpd_socket.xml b/lib/inets/doc/src/httpd_socket.xml
index 22ead06f38..6fac522617 100644
--- a/lib/inets/doc/src/httpd_socket.xml
+++ b/lib/inets/doc/src/httpd_socket.xml
@@ -97,7 +97,7 @@
<section>
<marker id="see_also"></marker>
<title>SEE ALSO</title>
- <p><seealso marker="httpd">httpd(3)</seealso></p>
+ <p><seeerl marker="httpd">httpd(3)</seeerl></p>
</section>
</erlref>
diff --git a/lib/inets/doc/src/httpd_util.xml b/lib/inets/doc/src/httpd_util.xml
index cd22b89314..9ee0d62ab4 100644
--- a/lib/inets/doc/src/httpd_util.xml
+++ b/lib/inets/doc/src/httpd_util.xml
@@ -380,7 +380,7 @@
<section>
<title>SEE ALSO</title>
- <p><seealso marker="httpd">httpd(3)</seealso></p>
+ <p><seeerl marker="httpd">httpd(3)</seeerl></p>
</section>
</erlref>
diff --git a/lib/inets/doc/src/inets.xml b/lib/inets/doc/src/inets.xml
index 176af3137a..cdf4eb940a 100644
--- a/lib/inets/doc/src/inets.xml
+++ b/lib/inets/doc/src/inets.xml
@@ -113,7 +113,7 @@
<desc>
<p>Starts the <c>Inets</c> application. Default type
is <c>temporary</c>. See also
- <seealso marker="kernel:application">application(3)</seealso>.</p>
+ <seeerl marker="kernel:application">application(3)</seeerl>.</p>
<marker id="stop"></marker>
</desc>
@@ -160,7 +160,7 @@
<fsummary>Stops the <c>Inets</c> application.</fsummary>
<desc>
<p>Stops the <c>Inets</c> application. See also
- <seealso marker="kernel:application">application(3)</seealso>.</p>
+ <seeerl marker="kernel:application">application(3)</seeerl>.</p>
<marker id="start2"></marker>
</desc>
@@ -188,8 +188,8 @@
<section>
<title>SEE ALSO</title>
- <p><seealso marker="httpc">httpc(3)</seealso>,
- <seealso marker="httpd">httpd(3)</seealso>
+ <p><seeerl marker="httpc">httpc(3)</seeerl>,
+ <seeerl marker="httpd">httpd(3)</seeerl>
</p>
</section>
diff --git a/lib/inets/doc/src/mod_alias.xml b/lib/inets/doc/src/mod_alias.xml
index 54ac70acfc..8183573ba4 100644
--- a/lib/inets/doc/src/mod_alias.xml
+++ b/lib/inets/doc/src/mod_alias.xml
@@ -57,7 +57,7 @@
file is found or if <c>Path</c> is not a directory.
<c>config_db()</c> is the server config file in ETS table format
as described in
- <seealso marker="http_server">Inets User's Guide</seealso>.</p>
+ <seeguide marker="http_server">Inets User's Guide</seeguide>.</p>
<marker id="path"></marker>
</desc>
@@ -82,7 +82,7 @@
exported, <c>ServerRoot</c> is used to
generate a file <c>Path</c>. <c>config_db()</c> and
<c>interaction_data()</c> are as defined in
- <seealso marker="http_server">Inets User's Guide</seealso>.</p>
+ <seeguide marker="http_server">Inets User's Guide</seeguide>.</p>
<marker id="real_name"></marker>
</desc>
@@ -106,14 +106,14 @@
<c>FakeName</c> is replaced with <c>RealName</c> in the
match. The resulting path is split into two parts,
<c>ShortPath</c> and <c>AfterPath</c>, as defined in
- <seealso marker="httpd_util#split_path/1">httpd_util:split_path/1</seealso>.
+ <seemfa marker="httpd_util#split_path/1">httpd_util:split_path/1</seemfa>.
<c>Path</c> is generated from <c>ShortPath</c>, that is,
the result from
- <seealso marker="#default_index">default_index/2</seealso> with
+ <seeerl marker="#default_index">default_index/2</seeerl> with
<c>ShortPath</c> as an argument.
<c>config_db()</c> is the server config file in ETS table
format as described in
- <seealso marker="http_server">Inets User's Guide</seealso>.</p>
+ <seeguide marker="http_server">Inets User's Guide</seeguide>.</p>
<marker id="real_script_name"></marker>
</desc>
@@ -140,10 +140,10 @@
<c>not_a_script</c> is returned. If it is a script, the
resulting script path is in two parts,
<c>ShortPath</c> and <c>AfterPath</c>, as defined in
- <seealso marker="httpd_util#split_script_path/1">httpd_util:split_script_path/1</seealso>.
+ <seemfa marker="httpd_util#split_script_path/1">httpd_util:split_script_path/1</seemfa>.
<c>config_db()</c> is the server config file in ETS table
format as described in
- <seealso marker="http_server">Inets User's Guide</seealso>.</p>
+ <seeguide marker="http_server">Inets User's Guide</seeguide>.</p>
</desc>
</func>
</funcs>
diff --git a/lib/inets/doc/src/mod_auth.xml b/lib/inets/doc/src/mod_auth.xml
index ad864ca4d1..2e0329dc98 100644
--- a/lib/inets/doc/src/mod_auth.xml
+++ b/lib/inets/doc/src/mod_auth.xml
@@ -289,8 +289,8 @@
<section>
<title>SEE ALSO</title>
- <p><seealso marker="httpd">httpd(3)</seealso>,
- <seealso marker="mod_alias">mod_alias(3)</seealso></p>
+ <p><seeerl marker="httpd">httpd(3)</seeerl>,
+ <seeerl marker="mod_alias">mod_alias(3)</seeerl></p>
</section>
</erlref>
diff --git a/lib/inets/doc/src/mod_esi.xml b/lib/inets/doc/src/mod_esi.xml
index bc5f98068f..42c4425ea0 100644
--- a/lib/inets/doc/src/mod_esi.xml
+++ b/lib/inets/doc/src/mod_esi.xml
@@ -155,11 +155,11 @@
a PUT or POST request. The default behavior (legacy reasons)
for delivering the body, is that the whole body is gathered and
converted to a string. But if the httpd config parameter
- <seealso
- marker="httpd#max_client_body_chunk">max_client_body_chunk</seealso>
+ <seeerl
+ marker="httpd#max_client_body_chunk">max_client_body_chunk</seeerl>
is set, the body will be delivered as binary chunks
- instead. The maximum size of the chunks is either <seealso
- marker="httpd#max_client_body_chunk">max_client_body_chunk</seealso>
+ instead. The maximum size of the chunks is either <seeerl
+ marker="httpd#max_client_body_chunk">max_client_body_chunk</seeerl>
or decide by the client if it uses HTTP chunked encoding
to send the body. When using the chunking
mechanism this callback must return {continue, State::term()}
diff --git a/lib/inets/doc/src/notes.xml b/lib/inets/doc/src/notes.xml
index 677fb33b87..93438a056f 100644
--- a/lib/inets/doc/src/notes.xml
+++ b/lib/inets/doc/src/notes.xml
@@ -2029,9 +2029,9 @@
<p>Better handling of errorI(s) during update of the session
database. </p>
<p>Also added and updated some debugging functions
- <seealso marker="httpc#which_sessions/0">which_sessions/[0,1]</seealso>
+ <seemfa marker="httpc#which_sessions/0">which_sessions/[0,1]</seemfa>
and
- <seealso marker="httpc#info/0">info/0</seealso>. </p>
+ <seemfa marker="httpc#info/0">info/0</seemfa>. </p>
<p>Own Id: OTP-10093</p>
<p>Aux Id: Seq 12062</p>
</item>
@@ -2103,11 +2103,11 @@
<item>
<p>[httpd] Make the server header configurable with new config
option
- <seealso marker="httpd#prop_server_tokens">server_tokens</seealso>.
+ <seeerl marker="httpd#prop_server_tokens">server_tokens</seeerl>.
The value of the server header, which was previously hard-coded
(at compile time), is now possible to manipulate through the means
of the
- <seealso marker="httpd#prop_server_tokens">server_tokens</seealso>
+ <seeerl marker="httpd#prop_server_tokens">server_tokens</seeerl>
config option. </p>
<p>Own Id: OTP-9805</p>
</item>
@@ -2125,16 +2125,16 @@
<item>
<p>[httpc] Add function for retrieving current options,
- <seealso marker="httpc#get_options/1">get_options/[1,2]</seealso>. </p>
+ <seemfa marker="httpc#get_options/1">get_options/[1,2]</seemfa>. </p>
<p>Own Id: OTP-9979</p>
</item>
<item>
<p>Utility module
- <seealso marker="http_uri">http_uri</seealso>
+ <seeerl marker="http_uri">http_uri</seeerl>
now officially supported. </p>
<p>Also, the
- <seealso marker="http_uri#parse">parse</seealso>
+ <seeerl marker="http_uri#parse">parse</seeerl>
function has been extended with more
scheme support and a way to provide your own scheme info. </p>
<p>Own Id: OTP-9983</p>
@@ -2243,7 +2243,7 @@
<list>
<item>
<p>[ftpc] Add a config option to specify a
- <seealso marker="ftp:ftp#dtimeout">data connect timeout</seealso>.
+ <seeerl marker="ftp:ftp#dtimeout">data connect timeout</seeerl>.
That is how long the ftp client will wait for the server to connect
to the data socket. If this timeout occurs, an error will be
returned to the caller and the ftp client process will be
@@ -2259,7 +2259,7 @@
A workaround for this is to use headers_as_is and provide the host
header with the requst call.
To solve this a new option has been added,
- <seealso marker="httpc#ipv6_host_with_brackets">ipv6_host_with_brackets</seealso>.
+ <seeerl marker="httpc#ipv6_host_with_brackets">ipv6_host_with_brackets</seeerl>.
This option specifies if the host value of the host header shall
include the brackets or not. By default, it does not (as before).
</p>
@@ -2306,7 +2306,7 @@
<item>
<p>[httpc] Deprecated interface module <c>http</c> has been removed.
It has (long) been replaced by http client interface module
- <seealso marker="httpc">httpc</seealso>. </p>
+ <seeerl marker="httpc">httpc</seeerl>. </p>
<p>Own Id: OTP-9359</p>
</item>
@@ -2371,7 +2371,7 @@
<item>
<p>[httpc] Deprecated interface module <c>http</c> has been removed.
It has (long) been replaced by http client interface module
- <seealso marker="httpc#">httpc</seealso>. </p>
+ <seeerl marker="httpc#">httpc</seeerl>. </p>
<p>Own Id: OTP-9359</p>
</item>
@@ -2500,7 +2500,7 @@
<p>[httpc] Add support for upload body streaming (PUT and POST).</p>
<p>For more info,
see the definition of the <c>Body</c> argument of the
- <seealso marker="httpc#request/4">request/[4,5]</seealso>
+ <seemfa marker="httpc#request/4">request/[4,5]</seemfa>
function. </p>
<p>Filipe David Manana</p>
<p>Own Id: OTP-9094</p>
@@ -2513,7 +2513,7 @@
<item>
<p>[httpd]
- <seealso marker="mod_esi#deliver/2">mod_esi:deliver/2</seealso>
+ <seemfa marker="mod_esi#deliver/2">mod_esi:deliver/2</seemfa>
made to accept binary data. </p>
<p>Bernard Duggan</p>
<p>Own Id: OTP-9123</p>
@@ -2541,7 +2541,7 @@
for using file descriptors has been improved.
It is now possible to add the file descriptor to the config
(option fd) when calling the
- <seealso marker="inets#start/2">inets:start(httpd, ...)</seealso>
+ <seemfa marker="inets#start/2">inets:start(httpd, ...)</seemfa>
function. </p>
<p>Attila Rajmund Nohl</p>
<p>Own Id: OTP-9202</p>
@@ -2553,9 +2553,9 @@
<p><c>ossl</c> will work for as long as the ssl application
supports it. </p>
<p>See the httpd
- <seealso marker="httpd#props_comm">socket_type</seealso>
+ <seeerl marker="httpd#props_comm">socket_type</seeerl>
communication property or the httpc
- <seealso marker="httpc#request/4">request/[4,5]</seealso> function
+ <seemfa marker="httpc#request/4">request/[4,5]</seemfa> function
for more info. </p>
<p>Own Id: OTP-9230</p>
<p>*** POTENTIAL INCOMPATIBILITY ***</p>
@@ -2572,7 +2572,7 @@
<list>
<item>
<p>[httpd] Wrong
- <seealso marker="httpd#props_sec">security property</seealso>
+ <seeerl marker="httpd#props_sec">security property</seeerl>
names used in documentation. </p>
<p><c>security_data_file</c> used instead of <c>data_file</c>. </p>
<p><c>security_max_retries</c> used instead of <c>max_retries</c>. </p>
@@ -2755,8 +2755,8 @@
<p>[httpc|httpd] - Now allow the use of the "new" ssl, by using
the <c>essl</c> tag instead. </p>
<p>See the <c>http_option</c> option in the
- <seealso marker="httpc#request/4">request/[4,5]</seealso> or
- the <seealso marker="httpd#props_comm">socket-type</seealso>
+ <seemfa marker="httpc#request/4">request/[4,5]</seemfa> or
+ the <seeerl marker="httpd#props_comm">socket-type</seeerl>
section of the Communication properties chapter for more info, </p>
<p>Own Id: OTP-7907</p>
</item>
@@ -2773,9 +2773,9 @@
<p>[httpd] - Improved mod_alias.
Now able to do better URL rewrites. </p>
<p>See
- <seealso marker="httpd#props_alias">URL aliasing properties</seealso>
+ <seeerl marker="httpd#props_alias">URL aliasing properties</seeerl>
and the
- <seealso marker="httpd#props_cgi">CGI properties</seealso>
+ <seeerl marker="httpd#props_cgi">CGI properties</seeerl>
section(s) for more info, </p>
<p>Own Id: OTP-8573</p>
</item>
@@ -2815,8 +2815,8 @@
<p>[httpc] - Allow users to pass socket options to the transport
module when making requests. </p>
<p>See the <c>socket_opts</c> option in the
- <seealso marker="httpc#request2">request/4</seealso> or
- <seealso marker="httpc#set_options">set_options/1,2</seealso>
+ <seeerl marker="httpc#request2">request/4</seeerl> or
+ <seeerl marker="httpc#set_options">set_options/1,2</seeerl>
for more info, </p>
<p>Own Id: OTP-8352</p>
</item>
@@ -2848,7 +2848,7 @@
<item>
<p>[httpd] - Added support (again) for the documented debugging
features. See the User's Guide
- <seealso marker="http_server#config">Configuration</seealso>
+ <seeguide marker="http_server#config">Configuration</seeguide>
chapter for more info. </p>
<p>Own Id: OTP-8624</p>
</item>
@@ -2870,8 +2870,8 @@
<p>[httpc] - Allow users to pass socket options to the transport
module when making requests. </p>
<p>See the <c>socket_opts</c> option in the
- <seealso marker="httpc#request2">request/4</seealso> or
- <seealso marker="httpc#set_options">set_options/1,2</seealso>
+ <seeerl marker="httpc#request2">request/4</seeerl> or
+ <seeerl marker="httpc#set_options">set_options/1,2</seeerl>
for more info, </p>
<p>Own Id: OTP-8352</p>
</item>
@@ -2922,8 +2922,8 @@
<p>[httpc] - Allow users to pass socket options to the transport
module when making requests. </p>
<p>See the <c>socket_opts</c> option in the
- <seealso marker="httpc#request2">request/4</seealso> or
- <seealso marker="httpc#set_options">set_options/1,2</seealso>
+ <seeerl marker="httpc#request2">request/4</seeerl> or
+ <seeerl marker="httpc#set_options">set_options/1,2</seeerl>
for more info, </p>
<p>Own Id: OTP-8352</p>
</item>
@@ -2985,8 +2985,8 @@
<p>[httpc] - Allow users to pass socket options to the transport
module when making requests. </p>
<p>See the <c>socket_opts</c> option in the
- <seealso marker="httpc#request/4">request/4</seealso> or
- <seealso marker="httpc#set_options/1">set_options/[1,2]</seealso>
+ <seemfa marker="httpc#request/4">request/4</seemfa> or
+ <seemfa marker="httpc#set_options/1">set_options/[1,2]</seemfa>
for more info, </p>
<p>Own Id: OTP-8352</p>
</item>
@@ -3027,7 +3027,7 @@
deliver an async reply to more receivers then the calling
process. </p>
<p>See the
- <seealso marker="httpc#request/2">receiver</seealso>
+ <seemfa marker="httpc#request/2">receiver</seemfa>
option for more info, </p>
<p>Own Id: OTP-8106</p>
</item>
@@ -3066,7 +3066,7 @@
</list>
<p>As a side-effect of these changes, some modules was also
renamed, and a new api module,
- <seealso marker="httpc">httpc</seealso>, has been introduced
+ <seeerl marker="httpc">httpc</seeerl>, has been introduced
(the old module <c>http</c> is <em>not</em> removed, but is
now just wrapper for <c>httpc</c>). </p>
<p>Own Id: OTP-8016</p>
@@ -3126,10 +3126,10 @@
<item>
<p>It is now also possible to start a standalone FTP client
process using the re-introduced
- <seealso marker="ftp:ftp#open">ftp:open</seealso>
+ <seeerl marker="ftp:ftp#open">ftp:open</seeerl>
function. </p>
<p>This is an alternative to starting the client using the
- <seealso marker="ftp:ftp#service_start">inets service framework</seealso>. </p>
+ <seeerl marker="ftp:ftp#service_start">inets service framework</seeerl>. </p>
<p>The old <c>ftp:open/1</c>, undocumented, function,
caused the client to be hooken into the inets service
supervision framework. This is <em>no</em> longer the
@@ -3142,10 +3142,10 @@
flag), and only used IPv4 if this did not work.
This has now been <em>changed</em>. </p>
<p>A new option,
- <seealso marker="ftp:ftp#ipfamily">ipfamily</seealso>,
+ <seeerl marker="ftp:ftp#ipfamily">ipfamily</seeerl>,
has been introduced, with the default value
<c>inet</c> (IPv4). </p>
- <p>See <seealso marker="ftp:ftp#open">ftp:open</seealso>
+ <p>See <seeerl marker="ftp:ftp#open">ftp:open</seeerl>
for more info.</p>
<p>*** POTENTIAL INCOMPATIBILITY ***</p>
</item>
@@ -3179,9 +3179,9 @@
<item>
<p>[ftpc] - The
- <seealso marker="ftp:ftp#ls2">ls/2</seealso> function (LIST command)
+ <seeerl marker="ftp:ftp#ls2">ls/2</seeerl> function (LIST command)
and the
- <seealso marker="ftp:ftp#nlist2">nlist/2</seealso> function
+ <seeerl marker="ftp:ftp#nlist2">nlist/2</seeerl> function
(NLST command)
with wildcards did
not work properly. </p>
@@ -3294,7 +3294,7 @@
request, when the client connects to the server. Default
value is that of the <c>timeout</c> option. </p>
<p>See the
- <seealso marker="httpc#request/4">request/[4,5]</seealso>
+ <seemfa marker="httpc#request/4">request/[4,5]</seemfa>
function for more info. </p>
<p>Own Id: OTP-7298</p>
<!-- <p>Aux Id: seq11086</p> -->
@@ -3357,7 +3357,7 @@
<p>Default is <c>inet6fb4</c> which emulates the
behaviour of the previous version. </p>
<p>See the
- <seealso marker="httpd#props_comm">Communication properties</seealso>
+ <seeerl marker="httpd#props_comm">Communication properties</seeerl>
section for more info. </p>
<p>Own Id: OTP-8069</p>
<p>Aux Id: seq11086</p>
@@ -3401,7 +3401,7 @@
the client connects to the server. </p>
<p>As a side-effect of this, the option <c>ipv6</c> has been
removed and replaced by the <c>ipfamily</c> option. </p>
- <p>See <seealso marker="httpc#set_options/1">http:set_options/[1,2]</seealso>
+ <p>See <seemfa marker="httpc#set_options/1">http:set_options/[1,2]</seemfa>
for more info. </p>
<p>*** POTENTIAL INCOMPATIBILITY ***</p>
<p>Own Id: OTP-8004</p>
diff --git a/lib/inets/doc/src/notes_history.xml b/lib/inets/doc/src/notes_history.xml
index 1523827db9..39a7b9da53 100644
--- a/lib/inets/doc/src/notes_history.xml
+++ b/lib/inets/doc/src/notes_history.xml
@@ -529,7 +529,7 @@
<list type="bulleted">
<item>
<p>[tftp] Added documentation (manual page) for
- <seealso marker="tftp">TFTP</seealso>.</p>
+ <seeerl marker="tftp">TFTP</seeerl>.</p>
<p>Own Id: OTP-6082</p>
</item>
</list>