Merge pull request arillso#13 from RickvdStaaij/fix-logrotate_applica…

…tions-exmaple

Update examples on how to correclty use logrotate_applications

CHANGELOG.md

@@ -3,6 +3,12 @@
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
 and [human-readable changelog](https://keepachangelog.com/en/1.0.0/).
 
+## 1.5.1
+
+### Fixed
+
+- Incorrect documentation adapted.
+
 ## 1.5.0
 
 ### Changed

README.md

@@ -96,16 +96,17 @@ logrotate_applications: []
 The following options are available.
 
 ```yml
-logrotate_applications
-     definitions:
-     - logs:
-       - /var/log/apt/term.log
-       - /var/log/apt/history.log
-       options:
-         - rotate 12
-         - monthly
-         - missingok
-         - notifempty
+logrotate_applications:
+  - name: name-your-log-rotate-application
+    definitions:
+      - logs:
+          - /var/log/apt/term.log
+          - /var/log/apt/history.log
+        options:
+          - rotate 12
+          - monthly
+          - missingok
+          - notifempty
 ```
 
 ## Dependencies

defaults/main.yml

@@ -30,16 +30,18 @@ logrotate_btmp:
     - create 0660 root utmp
     - rotate 1
 
-# More log files can be added that will logorate.
-# The following options are available.
-#      definitions:
-#      - logs:
-#        - /var/log/apt/term.log
-#        - /var/log/apt/history.log
-#        options:
-#          - rotate 12
-#          - monthly
-#          - missingok
-#          - notifempty
-#          - compress
+# More log files can be added that will log rotate.
+# An example of multiple log rotate applications with available settings:
+# logrotate_applications:
+#   - name: name-your-log-rotate-application
+#     definitions:
+#       - logs:
+#           - /var/log/apt/term.log
+#           - /var/log/apt/history.log
+#         options:
+#           - rotate 12
+#           - monthly
+#           - missingok
+#           - notifempty
+#           - compress
 logrotate_applications: []