File 0968-os_mon-Remove-reference-to-VxWorks-in-the-documentat.patch of Package erlang
From 4356ba21e35f1de29498b2723d8a426a5f772add Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= <bjorn@erlang.org>
Date: Thu, 27 Aug 2020 06:34:18 +0200
Subject: [PATCH 2/2] os_mon: Remove reference to VxWorks in the documentation
While at it, also remove references to Windows 98 and fix some minor typos.
---
lib/os_mon/doc/src/disksup.xml | 2 +-
lib/os_mon/doc/src/memsup.xml | 22 +++++++---------------
lib/os_mon/doc/src/notes.xml | 6 +++---
lib/os_mon/doc/src/nteventlog.xml | 9 +++------
lib/os_mon/doc/src/os_mon_app.xml | 2 +-
lib/os_mon/doc/src/os_sup.xml | 6 +++---
6 files changed, 18 insertions(+), 29 deletions(-)
diff --git a/lib/os_mon/doc/src/disksup.xml b/lib/os_mon/doc/src/disksup.xml
index 8c5cd62670..5a7eb4d27d 100644
--- a/lib/os_mon/doc/src/disksup.xml
+++ b/lib/os_mon/doc/src/disksup.xml
@@ -83,7 +83,7 @@
of Unix tools like <c>df</c>. The returned disk data and alarms
can be different when using this option.</p>
<p>The parameter is ignored on platforms that are known to not be
- posix compatible (Windows and SunOS).</p>
+ POSIX compatible (Windows and SunOS).</p>
</item>
</taglist>
<p>See <seealso marker="kernel:config">config(4)</seealso> for
diff --git a/lib/os_mon/doc/src/memsup.xml b/lib/os_mon/doc/src/memsup.xml
index 07d75a829b..450e73ea23 100644
--- a/lib/os_mon/doc/src/memsup.xml
+++ b/lib/os_mon/doc/src/memsup.xml
@@ -34,7 +34,7 @@
<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>.
- Available for Unix, Windows and VxWorks.</p>
+ Available for Unix and Windows.</p>
<p>Periodically performs a memory check:</p>
<list type="bulleted">
<item>
@@ -62,8 +62,8 @@
<seealso marker="#get_system_memory_data/0">get_system_memory_data()</seealso>.
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
- systems is however still valid, although sparse.</p>
+ without virtual memory. However, the output on other
+ systems is still valid, although sparse.</p>
<p>A call to <c>get_system_memory_data/0</c> is more costly
than a call to <c>get_memory_data/0</c> as data is collected
synchronously when this function is called.</p>
@@ -102,7 +102,8 @@
<item>
<p>A timeout, in seconds, for how long the <c>memsup</c>
process should wait for a result from a memory check. If
- the timeout expires, a warning message <c>"OS_MON (memsup) timeout"</c> is issued via <c>error_logger</c> and any
+ the timeout expires, a warning message <c>"OS_MON (memsup) timeout"</c>
+ is issued via <c>error_logger</c> and any
pending, synchronous client calls will return a dummy value.
Normally, this situation should not occur. There have been
cases on Linux, however, where the pseudo file from which
@@ -178,13 +179,6 @@
<item>The amount of memory available to the whole operating
system. This may well be equal to <c>total_memory</c> but
not necessarily.</item>
- <tag><c>largest_free</c></tag>
- <item>The size of the largest contiguous free memory block
- available to the Erlang emulator.</item>
- <tag><c>number_of_free</c></tag>
- <item>The number of free blocks available to the Erlang runtime
- system. This gives a fair indication of how fragmented
- the memory is.</item>
<tag><c>buffered_memory</c></tag>
<item>
The amount of memory the system uses for temporary storing raw disk blocks.
@@ -205,13 +199,11 @@
</taglist>
<p>All memory sizes are presented as number of <em>bytes</em>.</p>
- <p>The <c>largest_free</c> and <c>number_of_free</c> tags are
- currently only returned on a VxWorks system.</p>
<p>Returns the empty list [] if <c>memsup</c> is not available,
or if the memory check times out.</p>
<note><p>
- On linux the memory available to the emulator is <c>cached_memory</c> and <c>buffered_memory</c> in addition to
- <c>free_memory</c>.</p>
+ On Linux the memory available to the emulator is <c>cached_memory</c> and
+ <c>buffered_memory</c> in addition to <c>free_memory</c>.</p>
</note>
</desc>
</func>
diff --git a/lib/os_mon/doc/src/notes.xml b/lib/os_mon/doc/src/notes.xml
index b08ade9938..ab142d165a 100644
--- a/lib/os_mon/doc/src/notes.xml
+++ b/lib/os_mon/doc/src/notes.xml
@@ -733,7 +733,7 @@
<item>
<p> Memory information in
<c>memsup:get_system_memory_data/0</c> now has additional
- entries in its property list for linux.</p>
+ entries in its property list for Linux.</p>
<p>
Own Id: OTP-7409 Aux Id: seq10984 </p>
</item>
@@ -780,8 +780,8 @@
<list type="bulleted">
<item>
<p>
- Extended memsup memory probing on linux to use a port
- program to probe memory usage. This is faster then the
+ Extended memsup memory probing on Linux to use a port
+ program to probe memory usage. This is faster than the
previous implementation.</p>
<p>
Own Id: OTP-6860 Aux Id: seq10616 </p>
diff --git a/lib/os_mon/doc/src/nteventlog.xml b/lib/os_mon/doc/src/nteventlog.xml
index cb30a90390..53712a67ec 100644
--- a/lib/os_mon/doc/src/nteventlog.xml
+++ b/lib/os_mon/doc/src/nteventlog.xml
@@ -33,11 +33,8 @@
<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
- 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_mon_app">os_mon(6)</seealso>.</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>
<p>To retain backwards compatibility, this module can also be used
to start a standalone <c>nteventlog</c> process which is not part
@@ -55,7 +52,7 @@
sent to Erlang again after reboot).</p>
<p>If the event log is configured to wrap around automatically,
records that have arrived to the log and been overwritten when
- <c>nteventlog</c> was not running are lost. It however detects
+ <c>nteventlog</c> was not running are lost. However, it detects
this state and loses no records that are not overwritten.</p>
<p>The callback function works as described in <c>os_sup(3)</c>.</p>
</description>
diff --git a/lib/os_mon/doc/src/os_mon_app.xml b/lib/os_mon/doc/src/os_mon_app.xml
index 806a43fc04..35aff7503e 100644
--- a/lib/os_mon/doc/src/os_mon_app.xml
+++ b/lib/os_mon/doc/src/os_mon_app.xml
@@ -39,7 +39,7 @@
<item><seealso marker="disksup">disksup</seealso>
Disk supervision(Unix, Windows)</item>
<item><seealso marker="memsup">memsup</seealso>
- Memory supervision (Unix, Windows, VxWorks)</item>
+ Memory supervision (Unix, Windows)</item>
<item><seealso marker="os_sup">os_sup</seealso>
Interface to OS system messages (Solaris, Windows)</item>
</list>
diff --git a/lib/os_mon/doc/src/os_sup.xml b/lib/os_mon/doc/src/os_sup.xml
index 9c2088f784..f8b99f4f70 100644
--- a/lib/os_mon/doc/src/os_sup.xml
+++ b/lib/os_mon/doc/src/os_sup.xml
@@ -45,14 +45,14 @@
<section>
<title>Solaris Operation</title>
<p>The Solaris (SunOS 5.x) messages are retrieved from
- the syslog-daemon, <c>syslogd</c>.</p>
+ the syslog daemon, <c>syslogd</c>.</p>
<p>Enabling the service includes actions which require root
privileges, such as change of ownership and file privileges of an
executable binary file, and creating a modified copy of
the configuration file for <c>syslogd</c>. When <c>os_sup</c> is
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
+ either outside or inside <c>os_sup</c>. See
<seealso marker="#config">Configuration</seealso> below.</p>
<warning>
<p>This process cannot run in multiple instances on the same
@@ -69,7 +69,7 @@
<p>The <c>nteventlog</c> module is used to implement <c>os_sup</c>.
See <seealso marker="nteventlog">nteventlog(3)</seealso>. 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
+ used, as in this case the process is started automatically as part of
the OS_Mon supervision tree.</p>
<p>OS messages are formatted as a tuple
<c>{Time, Category, Facility, Severity, Message}</c>:</p>
--
2.26.2
