Add description to log rotate class

diff --git a/lib/log/rotate.php b/lib/log/rotate.php
index d79fd40342cc415f833ad5bfc0ae4abc7e977762..3b976d50dceb66a3003f331fde2fa2a93881f170 100644 (file)
--- a/lib/log/rotate.php
+++ b/lib/log/rotate.php
@@ -8,6 +8,13 @@
 
 namespace OC\Log;
 
+/**
+ * This rotates the current logfile to a new name, this way the total log usage
+ * will stay limited and older entries are available for a while longer. The
+ * total disk usage is twice LOG_SIZE_LIMIT.
+ * For more professional log management set the 'logfile' config to a different
+ * location and manage that with your own tools.
+ */
 class Rotate extends \OC\BackgroundJob\Job {
        const LOG_SIZE_LIMIT = 104857600; // 100 MB
        public function run($logFile) {