File 1201-Link-from-timer-module-doc-to-the-Efficien... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1201-Link-from-timer-module-doc-to-the-Efficiency-Guide.patch of Package erlang

From dc7bebdb26745edeae8efee11ddb1f23c84bb48f Mon Sep 17 00:00:00 2001
From: Radek Szymczyszyn <radoslaw.szymczyszyn@erlang-solutions.com>
Date: Fri, 18 Dec 2020 10:47:45 +0100
Subject: [PATCH] Link from timer module doc to the Efficiency Guide

---
 lib/stdlib/doc/src/timer.xml | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/lib/stdlib/doc/src/timer.xml b/lib/stdlib/doc/src/timer.xml
index f44caf9ce2..56342b94be 100644
--- a/lib/stdlib/doc/src/timer.xml
+++ b/lib/stdlib/doc/src/timer.xml
@@ -47,6 +47,12 @@
 must not be changed.
 The time-outs are not exact, but are at least as long
 as requested.
+ Creating timers using
+ <seealso marker="erts:erlang#send_after/3">erlang:send_after/3</seealso> and
+ <seealso marker="erts:erlang#start_timer/3">erlang:start_timer/3</seealso>
+ is much more efficient than using the timers provided by this module. See
+ <seealso marker="system/efficiency_guide:commoncaveats#timer-module">the
+ Timer Module section in the Efficiency Guide</seealso>.
 </description>
 
 <datatypes>
@@ -195,6 +201,9 @@
 can also be an atom of a registered name.)
 Returns <c>{ok, <anno>TRef</anno>}</c> or
 <c>{error, <anno>Reason</anno>}</c>.
+ See also
+ <seealso marker="system/efficiency_guide:commoncaveats#timer-module">
+ the Timer Module section in the Efficiency Guide</seealso>.
 </item>
 <tag><c>send_after/2</c></tag>
 <item>
-- 
2.26.2

Places

File 1201-Link-from-timer-module-doc-to-the-Efficiency-Guide.patch of Package erlang

Places