Move logrotate comments to separate lines

because logrotate doesn't support in-line comments. Relates #821
elastic · Nov 19, 2019 · 12a5b34 · 12a5b34
1 parent bd8c605
commit 12a5b34
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 14 deletions.
diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -126,13 +126,20 @@ By default, Rally will log all output to ``~/.rally/logs/rally.log``.
 The log file will not be rotated automatically as this is problematic due to Rally's multi-process architecture. Setup an external tool like `logrotate <https://linux.die.net/man/8/logrotate>`_ to achieve that. See the following example as a starting point for your own ``logrotate`` configuration and ensure to replace the path ``/home/user/.rally/logs/rally.log`` with the proper one::
 
     /home/user/.rally/logs/rally.log {
-            daily                   # rotate daily
-            rotate 7                # keep the last seven log files
-            maxage 14               # remove logs older than 14 days
-            compress                # compress old logs ...
-            delaycompress           # ... after moving them
-            missingok               # ignore missing log files
-            notifempty              # don't attempt to rotate empty ones
+            # rotate daily
+            daily
+            # keep the last seven log files
+            rotate 7
+            # remove logs older than 14 days
+            maxage 14
+            # compress old logs ...
+            compress
+            # ... after moving them
+            delaycompress
+            # ignore missing log files
+            missingok
+            # don't attempt to rotate empty ones
+            notifempty
     }
 
 Example

diff --git a/docs/migrate.rst b/docs/migrate.rst
@@ -156,13 +156,20 @@ With Rally 1.0.1 we have disabled automatic rotation of logs by default because
 To rotate logs we recommend to use external tools like `logrotate <https://linux.die.net/man/8/logrotate>`_. See the following example as a starting point for your own ``logrotate`` configuration and ensure to replace the path ``/home/user/.rally/logs/rally.log`` with the proper one::
 
     /home/user/.rally/logs/rally.log {
-            daily                   # rotate daily
-            rotate 7                # keep the last seven log files
-            maxage 14               # remove logs older than 14 days
-            compress                # compress old logs ...
-            delaycompress           # ... after moving them
-            missingok               # ignore missing log files
-            notifempty              # don't attempt to rotate empty ones
+            # rotate daily
+            daily
+            # keep the last seven log files
+            rotate 7
+            # remove logs older than 14 days
+            maxage 14
+            # compress old logs ...
+            compress
+            # ... after moving them
+            delaycompress
+            # ignore missing log files
+            missingok
+            # don't attempt to rotate empty ones
+            notifempty
     }
 
 Migrating to Rally 1.0.0