From 5881e8eccd82db4db7aed67f833e0bb760036421 Mon Sep 17 00:00:00 2001
From: Next Turn <45985406+NextTurn@users.noreply.github.com>
Date: Thu, 23 Apr 2020 05:08:54 +0800
Subject: [PATCH] Warn about broken auto-archiving settings (#522)

* Warn about broken settings

* Apply suggestions from code review

Co-Authored-By: Oleg Nenashev <o.v.nenashev@gmail.com>

* Apply suggestions from code review

Co-authored-by: Oleg Nenashev <o.v.nenashev@gmail.com>
---
 doc/loggingAndErrorReporting.md | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/doc/loggingAndErrorReporting.md b/doc/loggingAndErrorReporting.md
index 9c86398..027f21f 100644
--- a/doc/loggingAndErrorReporting.md
+++ b/doc/loggingAndErrorReporting.md
@@ -67,8 +67,6 @@ Works in a combination of rotate size mode and rotate time mode, if the log file
   <sizeThreshold>10240</sizeThreshold>
   <pattern>yyyyMMdd</pattern>
   <autoRollAtTime>00:00:00</autoRollAtTime>
-  <zipOlderThanNumDays>5</zipOlderThanNumDays>
-  <zipDateFormat>yyyyMM</zipDateFormat>
 </log>
 ```
 
@@ -78,6 +76,19 @@ For example, in the above example, the log of Jan 1, 2013 gets written to `myapp
 The syntax of the autoRollAtTime is specified by [TimeSpan.ToString(String)](https://docs.microsoft.com/dotnet/api/system.timespan.tostring#System_TimeSpan_ToString_System_String_).
 For example, in the above example, at the start of the day it will roll the file over.
 
+### Automatic archiving of logs
+
+:warning: This feature is reported to be broken in recent WinSW versions.
+It is a potential subject for removal.
+
+
+```xml
+<log mode="roll-by-size-time">
+  <zipOlderThanNumDays>5</zipOlderThanNumDays>
+  <zipDateFormat>yyyyMM</zipDateFormat>
+</log>
+```
+
 The `zipOlderThanNumDays` can only be used in conjection with autoRollAtTime, provide the number of days of files to keep.
 
 ```xml