From: Eric Covener <covener@apache.org>
Date: Mon, 28 Mar 2022 00:06:37 +0000 (+0000)
Subject: add -n warnings/quirks
X-Git-Tag: 2.5.0-alpha2-ci-test-only~429
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=79055994d4e9ad687b559596951076ce8fd82dcf;p=thirdparty%2Fapache%2Fhttpd.git

add -n warnings/quirks

https://bz.apache.org/bugzilla/show_bug.cgi?id=65980


[skip ci]


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1899269 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/docs/manual/programs/rotatelogs.xml b/docs/manual/programs/rotatelogs.xml
index 3ecc3ce22cf..e1e6f1ce21f 100644
--- a/docs/manual/programs/rotatelogs.xml
+++ b/docs/manual/programs/rotatelogs.xml
@@ -117,9 +117,16 @@ processed in real time by a further tool in the chain.</dd>
 <dd>Create log file for each interval, even if empty.</dd>
 
 <dt><code>-n <var>number-of-files</var></code></dt>
-<dd>Use a circular list of filenames without timestamps.
-With -n 3, the series of log files opened would be
-"logfile", "logfile.1", "logfile.2", then overwriting "logfile".<br />
+<dd>Use a circular list of filenames without timestamps. This option overwrites 
+log files at startup and during rotation.  With -n 3, the series of log 
+files opened would be "logfile", "logfile.1", "logfile.2", then overwriting 
+"logfile". 
+<br/>
+When this program first opens "logfile", the file will only be truncated if <code>-t</code> is also provided. Every subsequent rotation will
+always begin with truncation of the target file.  For size based rotation without <code>-t</code> and existing log files in place,
+this option may result in unintuitive behavior such as initial log entries being sent to "logfile.1", and entries in "logfile.1" not being preserved
+even if later "logfile.n" have not yet been used.
+<br/>
 Available in 2.4.5 and later.</dd>
 
 <dt><code><var>logfile</var></code></dt>