diff options
| author | Siri Hansen <[email protected]> | 2016-01-27 11:02:26 +0100 |
|---|---|---|
| committer | Siri Hansen <[email protected]> | 2016-01-27 11:02:26 +0100 |
| commit | 5ebe9f68a34716eeb3739762e39f9afb4a945932 (patch) | |
| tree | d2a799c011e570d5c13adf4ced8390c67859144a /lib/sasl/doc | |
| parent | 8a9e1a85a372055a1e8c1dcceec0991b4740ad12 (diff) | |
| parent | a42724e6740df6290ec7f7dceb09db4f217697d8 (diff) | |
| download | otp-5ebe9f68a34716eeb3739762e39f9afb4a945932.tar.gz otp-5ebe9f68a34716eeb3739762e39f9afb4a945932.tar.bz2 otp-5ebe9f68a34716eeb3739762e39f9afb4a945932.zip | |
Merge branch 'siri/deprecate-overload/OTP-13057' into maint
* siri/deprecate-overload/OTP-13057:
Deprecate module 'overload' in SASL
Diffstat (limited to 'lib/sasl/doc')
| -rw-r--r-- | lib/sasl/doc/src/overload.xml | 6 | ||||
| -rw-r--r-- | lib/sasl/doc/src/sasl_app.xml | 6 |
2 files changed, 11 insertions, 1 deletions
diff --git a/lib/sasl/doc/src/overload.xml b/lib/sasl/doc/src/overload.xml index 5c3d00afeb..2f19cd9088 100644 --- a/lib/sasl/doc/src/overload.xml +++ b/lib/sasl/doc/src/overload.xml @@ -35,6 +35,12 @@ <module>overload</module> <modulesummary>An Overload Regulation Process</modulesummary> <description> + <warning> + <p> + All functions in this module are deprecated and will be + removed in a future release. + </p> + </warning> <p><c>overload</c> is a process that indirectly regulates the CPU usage in the system. The idea is that a main application calls function diff --git a/lib/sasl/doc/src/sasl_app.xml b/lib/sasl/doc/src/sasl_app.xml index 8d79251c7e..bcd446a868 100644 --- a/lib/sasl/doc/src/sasl_app.xml +++ b/lib/sasl/doc/src/sasl_app.xml @@ -34,7 +34,7 @@ <p>The <c>SASL</c> application provides the following services:</p> <list type="bulleted"> <item><c>alarm_handler</c></item> - <item><c>overload</c></item> + <item><c>overload</c> (deprecated)</item> <item><c>rb</c></item> <item><c>release_handler</c></item> <item><c>systools</c></item> @@ -145,11 +145,15 @@ <p>Specifies the maximum intensity for <seealso marker="overload"><c>overload</c></seealso>. Default is <c>0.8</c>.</p> + <p>Note that the <c>overload</c> module is deprected and + will be removed in a future release.</p> </item> <tag><c><![CDATA[overload_weight = float() > 0 ]]></c></tag> <item> <p>Specifies the <seealso marker="overload"><c>overload</c></seealso> weight. Default is <c>0.1</c>.</p> + <p>Note that the <c>overload</c> module is deprected and + will be removed in a future release.</p> </item> <tag><c><![CDATA[start_prg = string() ]]></c></tag> <item> |