From 9ff9e4cbbeb26b5d420e4552dedbda1820660ed7 Mon Sep 17 00:00:00 2001
From: Sverker Eriksson <sverker@erlang.org>
Date: Fri, 17 Nov 2017 16:27:40 +0100
Subject: erts: Clarify RUN_ERL_LOG_GENERATIONS

---
 erts/doc/src/run_erl.xml | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'erts/doc')

diff --git a/erts/doc/src/run_erl.xml b/erts/doc/src/run_erl.xml
index a9b6a7e2c6..e4c1b943c4 100644
--- a/erts/doc/src/run_erl.xml
+++ b/erts/doc/src/run_erl.xml
@@ -181,6 +181,12 @@
       <item>
         <p>Controls the number of log files written before older
           files are reused. Defaults to 5, minimum is 2, maximum is 1000.</p>
+	<p>Note that, as a way to indicate the newest file, <c>run_erl</c> will
+	delete the oldest log file to maintain a "hole" in the file
+	sequences. For example, if log files #1, #2, #4 and #5 exists, that
+	means #2 is the latest and #4 is the oldest. You will therefore at most
+	get one less log file than the value set by
+	<c>RUN_ERL_LOG_GENERATIONS</c>.</p>
       </item>
       <tag><c>RUN_ERL_LOG_MAXSIZE</c></tag>
       <item>
-- 
cgit v1.2.3