Merge pull request #133 from jamezp/LOGMGR-160

[LOGMGR-160] Correct the JavaDoc that indicates files will not be del…
jboss-logging · Aug 16, 2017 · 0f9144b · 0f9144b
2 parents fbd552b + 4a1fc3a
commit 0f9144b
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/src/main/java/org/jboss/logmanager/handlers/SizeRotatingFileHandler.java b/src/main/java/org/jboss/logmanager/handlers/SizeRotatingFileHandler.java
@@ -217,8 +217,11 @@ public String getSuffix() {
      * <p>
      * If the suffix ends with {@code .gz} or {@code .zip} the file will be compressed on rotation.
      * </p>
-     * <b>Note:</b> Any files rotated with the suffix appended will not be deleted. The {@link #setMaxBackupIndex(int)
-     * maxBackupIndex} is not used for files with a suffix.
+     * <p>
+     * <b>Note:</b> The {@link #setMaxBackupIndex(int) maxBackupIndex} only takes into account files rotated with same
+     * suffix. For example if the suffix pattern is {@code .yyyy-MM-dd} and the size rotation is reached only files
+     * with the same date suffix will be purged. A file the day before or after will not be purged.
+     * </p>
      *
      * @param suffix the suffix to place after the filename when the file is rotated
      */