diff options
author | Lukas Larsson <lukas@erlang.org> | 2020-03-11 10:11:22 +0100 |
---|---|---|
committer | Lukas Larsson <lukas@erlang.org> | 2020-03-27 11:02:23 +0100 |
commit | 0799c2b0e9ae5fce18d092a153fff884d1dd3912 (patch) | |
tree | c7c72465bd01591a9163e5ad17cea92bf3be75ec /lib/os_mon/doc | |
parent | 6c6fe8e774f7cde6d158b450fd1ad6c3129dc22e (diff) | |
download | erlang-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/os_mon/doc')
-rw-r--r-- | lib/os_mon/doc/src/cpu_sup.xml | 4 | ||||
-rw-r--r-- | lib/os_mon/doc/src/disksup.xml | 14 | ||||
-rw-r--r-- | lib/os_mon/doc/src/memsup.xml | 22 | ||||
-rw-r--r-- | lib/os_mon/doc/src/nteventlog.xml | 8 | ||||
-rw-r--r-- | lib/os_mon/doc/src/os_mon_app.xml | 22 | ||||
-rw-r--r-- | lib/os_mon/doc/src/os_sup.xml | 12 |
6 files changed, 41 insertions, 41 deletions
diff --git a/lib/os_mon/doc/src/cpu_sup.xml b/lib/os_mon/doc/src/cpu_sup.xml index b7adb2bcd2..493a8040c1 100644 --- a/lib/os_mon/doc/src/cpu_sup.xml +++ b/lib/os_mon/doc/src/cpu_sup.xml @@ -33,7 +33,7 @@ <description> <p><c>cpu_sup</c> is a process which supervises the CPU load and CPU utilization. It is part of the OS_Mon application, see - <seealso marker="os_mon_app">os_mon(6)</seealso>. Available for Unix, + <seeapp marker="os_mon_app">os_mon(6)</seeapp>. Available for Unix, although CPU utilization values (<c>util/0,1</c>) are only available for Solaris, Linux and FreeBSD.</p> <p>The load values are proportional to how long time a runnable @@ -276,7 +276,7 @@ <section> <title>See Also</title> - <p><seealso marker="os_mon_app">os_mon(3)</seealso></p> + <p><seeapp marker="os_mon_app">os_mon(3)</seeapp></p> </section> </erlref> diff --git a/lib/os_mon/doc/src/disksup.xml b/lib/os_mon/doc/src/disksup.xml index 116a6dfd19..8c5cd62670 100644 --- a/lib/os_mon/doc/src/disksup.xml +++ b/lib/os_mon/doc/src/disksup.xml @@ -33,7 +33,7 @@ <description> <p><c>disksup</c> is a process which supervises the available disk space in the system. It is part of the OS_Mon application, see - <seealso marker="os_mon_app">os_mon(6)</seealso>. Available for Unix + <seeapp marker="os_mon_app">os_mon(6)</seeapp>. Available for Unix and Windows.</p> <p>Periodically checks the disks. For each disk or partition which uses more than a certain amount of the available space, the alarm @@ -50,7 +50,7 @@ </item> </taglist> <p>Alarms are reported to the SASL alarm handler, see - <seealso marker="sasl:alarm_handler">alarm_handler(3)</seealso>. + <seeerl marker="sasl:alarm_handler">alarm_handler(3)</seeerl>. To set an alarm, <c>alarm_handler:set_alarm(Alarm)</c> is called where <c>Alarm</c> is the alarm specified above.</p> <p>The alarms are cleared automatically when the alarm cause is no @@ -86,7 +86,7 @@ posix compatible (Windows and SunOS).</p> </item> </taglist> - <p>See <seealso marker="kernel:config">config(4)</seealso> for + <p>See <seefile marker="kernel:config">config(4)</seefile> for information about how to change the value of configuration parameters.</p> </section> @@ -134,7 +134,7 @@ <p>The change will take effect after the next disk space check and is non-persist. That is, in case of a process restart, this value is forgotten and the default value will be used. - See <seealso marker="#config">Configuration</seealso> above.</p> + See <seeerl marker="#config">Configuration</seeerl> above.</p> </desc> </func> <func> @@ -159,15 +159,15 @@ <p>The change will take effect during the next disk space check and is non-persist. That is, in case of a process restart, this value is forgotten and the default value will be used. - See <seealso marker="#config">Configuration</seealso> above.</p> + See <seeerl marker="#config">Configuration</seeerl> above.</p> </desc> </func> </funcs> <section> <title>See Also</title> - <p><seealso marker="sasl:alarm_handler">alarm_handler(3)</seealso>, - <seealso marker="os_mon_app">os_mon(3)</seealso></p> + <p><seeerl marker="sasl:alarm_handler">alarm_handler(3)</seeerl>, + <seeapp marker="os_mon_app">os_mon(3)</seeapp></p> </section> </erlref> diff --git a/lib/os_mon/doc/src/memsup.xml b/lib/os_mon/doc/src/memsup.xml index 51c78b07c2..07d75a829b 100644 --- a/lib/os_mon/doc/src/memsup.xml +++ b/lib/os_mon/doc/src/memsup.xml @@ -33,7 +33,7 @@ <description> <p><c>memsup</c> is a process which supervises the memory usage for the system and for individual processes. It is part of the OS_Mon - application, see <seealso marker="os_mon_app">os_mon(6)</seealso>. + application, see <seeapp marker="os_mon_app">os_mon(6)</seeapp>. Available for Unix, Windows and VxWorks.</p> <p>Periodically performs a memory check:</p> <list type="bulleted"> @@ -49,17 +49,17 @@ </item> </list> <p>Alarms are reported to the SASL alarm handler, see - <seealso marker="sasl:alarm_handler">alarm_handler(3)</seealso>. + <seeerl marker="sasl:alarm_handler">alarm_handler(3)</seeerl>. To set an alarm, <c>alarm_handler:set_alarm(Alarm)</c> is called where <c>Alarm</c> is either of the alarms specified above.</p> <p>The alarms are cleared automatically when the alarm cause is no longer valid.</p> <p>The function - <seealso marker="#get_memory_data/0">get_memory_data()</seealso> + <seemfa marker="#get_memory_data/0">get_memory_data()</seemfa> can be used to retrieve the result of the latest periodic memory check.</p> <p>There is also a interface to system dependent memory data, - <seealso marker="#get_system_memory_data/0">get_system_memory_data()</seealso>. + <seemfa marker="#get_system_memory_data/0">get_system_memory_data()</seemfa>. The result is highly dependent on the underlying operating system and the interface is targeted primarily for systems without virtual memory (e.g. VxWorks). The output on other @@ -121,7 +121,7 @@ check makes a traversal of the entire list of processes.</p> </item> </taglist> - <p>See <seealso marker="kernel:config">config(4)</seealso> for + <p>See <seefile marker="kernel:config">config(4)</seefile> for information about how to change the value of configuration parameters.</p> </section> @@ -248,7 +248,7 @@ <p>The change will take effect after the next memory check and is non-persistent. That is, in case of a process restart, this value is forgotten and the default value will be used. See - <seealso marker="#config">Configuration</seealso> above.</p> + <seeerl marker="#config">Configuration</seeerl> above.</p> </desc> </func> <func> @@ -268,7 +268,7 @@ <p>The change will take effect during the next periodic memory check and is non-persistent. That is, in case of a process restart, this value is forgotten and the default value will be - used. See <seealso marker="#config">Configuration</seealso> + used. See <seeerl marker="#config">Configuration</seeerl> above.</p> </desc> </func> @@ -289,7 +289,7 @@ <p>The change will take effect during the next periodic memory check and is non-persistent. That is, in case of a process restart, this value is forgotten and the default value will be - used. See <seealso marker="#config">Configuration</seealso> + used. See <seeerl marker="#config">Configuration</seeerl> above.</p> </desc> </func> @@ -315,15 +315,15 @@ <p>The change will take effect for the next memory check and is non-persistent. That is, in the case of a process restart, this value is forgotten and the default value will be used. See - <seealso marker="#config">Configuration</seealso> above.</p> + <seeerl marker="#config">Configuration</seeerl> above.</p> </desc> </func> </funcs> <section> <title>See Also</title> - <p><seealso marker="sasl:alarm_handler">alarm_handler(3)</seealso>, - <seealso marker="os_mon_app">os_mon(3)</seealso></p> + <p><seeerl marker="sasl:alarm_handler">alarm_handler(3)</seeerl>, + <seeapp marker="os_mon_app">os_mon(3)</seeapp></p> </section> </erlref> diff --git a/lib/os_mon/doc/src/nteventlog.xml b/lib/os_mon/doc/src/nteventlog.xml index 08cf165a24..cb30a90390 100644 --- a/lib/os_mon/doc/src/nteventlog.xml +++ b/lib/os_mon/doc/src/nteventlog.xml @@ -33,12 +33,12 @@ <description> <p><c>nteventlog</c> provides a generic interface to the Windows event log. It is part of the OS_Mon application, see - <seealso marker="os_mon_app">os_mon(6)</seealso>. Available for + <seeapp marker="os_mon_app">os_mon(6)</seeapp>. Available for Windows versions where the event log is available. That is, not for Windows 98 and some other older Windows versions, but for most (all?) newer Windows versions.</p> <p>This module is used as the Windows backend for <c>os_sup</c>, see - <seealso marker="os_sup">os_sup(3)</seealso>.</p> + <seeerl marker="os_sup">os_sup(3)</seeerl>.</p> <p>To retain backwards compatibility, this module can also be used to start a standalone <c>nteventlog</c> process which is not part of the OS_Mon supervision tree. When starting such a process, @@ -97,8 +97,8 @@ <section> <title>See Also</title> - <p><seealso marker="os_mon_app">os_mon(6)</seealso>, - <seealso marker="os_sup">os_sup(3)</seealso></p> + <p><seeapp marker="os_mon_app">os_mon(6)</seeapp>, + <seeerl marker="os_sup">os_sup(3)</seeerl></p> <p>Windows NT documentation</p> </section> </erlref> diff --git a/lib/os_mon/doc/src/os_mon_app.xml b/lib/os_mon/doc/src/os_mon_app.xml index c77a9d0411..806a43fc04 100644 --- a/lib/os_mon/doc/src/os_mon_app.xml +++ b/lib/os_mon/doc/src/os_mon_app.xml @@ -34,13 +34,13 @@ <p>The operating system monitor, OS_Mon, provides the following services:</p> <list type="bulleted"> - <item><seealso marker="cpu_sup">cpu_sup</seealso> + <item><seeerl marker="cpu_sup">cpu_sup</seeerl> CPU load and utilization supervision (Unix)</item> - <item><seealso marker="disksup">disksup</seealso> + <item><seeerl marker="disksup">disksup</seeerl> Disk supervision(Unix, Windows)</item> - <item><seealso marker="memsup">memsup</seealso> + <item><seeerl marker="memsup">memsup</seeerl> Memory supervision (Unix, Windows, VxWorks)</item> - <item><seealso marker="os_sup">os_sup</seealso> + <item><seeerl marker="os_sup">os_sup</seeerl> Interface to OS system messages (Solaris, Windows)</item> </list> <p>To simplify usage of OS_Mon on distributed Erlang systems, it is @@ -82,19 +82,19 @@ </taglist> <p>Configuration parameters effecting the different OS_Mon services are described in the respective man pages.</p> - <p>See <seealso marker="kernel:config">config(4)</seealso> for + <p>See <seefile marker="kernel:config">config(4)</seefile> for information about how to change the value of configuration parameters.</p> </section> <section> <title>See Also</title> - <p><seealso marker="cpu_sup">cpu_sup(3)</seealso>, - <seealso marker="disksup">disksup(3)</seealso>, - <seealso marker="memsup">memsup(3)</seealso>, - <seealso marker="os_sup">os_sup(3)</seealso>, - <seealso marker="nteventlog">nteventlog(3)</seealso>, - <seealso marker="snmp:snmp">snmp(3)</seealso>.</p> + <p><seeerl marker="cpu_sup">cpu_sup(3)</seeerl>, + <seeerl marker="disksup">disksup(3)</seeerl>, + <seeerl marker="memsup">memsup(3)</seeerl>, + <seeerl marker="os_sup">os_sup(3)</seeerl>, + <seeerl marker="nteventlog">nteventlog(3)</seeerl>, + <seeerl marker="snmp:snmp">snmp(3)</seeerl>.</p> </section> </appref> diff --git a/lib/os_mon/doc/src/os_sup.xml b/lib/os_mon/doc/src/os_sup.xml index 4a84165a6c..9c2088f784 100644 --- a/lib/os_mon/doc/src/os_sup.xml +++ b/lib/os_mon/doc/src/os_sup.xml @@ -34,7 +34,7 @@ <p><c>os_sup</c> is a process providing a message passing service from the operating system to the error logger in the Erlang runtime system. It is part of the OS_Mon application, see - <seealso marker="os_mon_app">os_mon(6)</seealso>. Available for + <seeapp marker="os_mon_app">os_mon(6)</seeapp>. Available for Solaris and Windows.</p> <p>Messages received from the operating system results in an user defined callback function being called. This function can do @@ -53,7 +53,7 @@ terminated, the service must be disabled, meaning the original configuration must be restored. Enabling/disabling can be done either outside or inside <c>os_sup</c>, see - <seealso marker="#config">Configuration</seealso> below.</p> + <seeerl marker="#config">Configuration</seeerl> below.</p> <warning> <p>This process cannot run in multiple instances on the same hardware. OS_Mon must be configured to start <c>os_sup</c> on @@ -67,7 +67,7 @@ <title>Windows Operation</title> <p>The Windows messages are retrieved from the eventlog file.</p> <p>The <c>nteventlog</c> module is used to implement <c>os_sup</c>. - See <seealso marker="nteventlog">nteventlog(3)</seealso>. Note + See <seeerl marker="nteventlog">nteventlog(3)</seeerl>. Note that the start functions of <c>nteventlog</c> does not need to be used, in this case the process is started automatically as part of the OS_Mon supervision tree.</p> @@ -123,7 +123,7 @@ called as <c>apply(Module, Function, [Msg | Args])</c>.</p> <p>Default is <c>{os_sup, error_report, [Tag]}</c> which will send the event to the error logger using - <seealso marker="kernel:error_logger#error_report/2">error_logger:error_report(Tag, Msg)</seealso>. <c>Tag</c> is the value of + <seemfa marker="kernel:error_logger#error_report/2">error_logger:error_report(Tag, Msg)</seemfa>. <c>Tag</c> is the value of <c>os_sup_errortag</c>, see below.</p> </item> <tag><c>os_sup_errortag = atom()</c></tag> @@ -232,8 +232,8 @@ <section> <title>See also</title> - <p><seealso marker="kernel:error_logger">error_logger(3)</seealso>, - <seealso marker="os_mon_app">os_mon(3)</seealso></p> + <p><seeerl marker="kernel:error_logger">error_logger(3)</seeerl>, + <seeapp marker="os_mon_app">os_mon(3)</seeapp></p> <p><c>syslogd(1M)</c>, <c>syslog.conf(4)</c> in the Solaris documentation.</p> <p></p> |