Fix documentation for log_dir parameter

Change-Id: I283453057845af1ec8e4e1e0419db2e9d5893abf Partial-Bug: #1600294
6 years ago · 765557b9dc
3 changed files with 5 additions and 2 deletions
--- a/manifests/init.pp
+++ b/manifests/init.pp
@ -36,7 +36,7 @@
 #
 #  [*log_dir*]
 #    (Optional) Directory to which ceilometer logs are sent.
-#    If set to boolean false, it will not log to any directory.
+#    If set to $::os_service_default, it will not log to any directory.
 #    Defaults to undef.
 #
 #  [*use_syslog*]
--- a/manifests/logging.pp
+++ b/manifests/logging.pp
@ -22,7 +22,7 @@
 #
 # [*log_dir*]
 #   (Optional) Directory where logs should be stored.
-#   If set to boolean false, it will not log to any directory.
+#   If set to $::os_service_default, it will not log to any directory.
 #   Defaults to '/var/log/ceilometer'.
 #
 # [*logging_context_format_string*]
--- a/releasenotes/notes/fix_log_dir_documentation-6f0c7311a8678413.yaml
+++ b/releasenotes/notes/fix_log_dir_documentation-6f0c7311a8678413.yaml
@ -0,0 +1,3 @@
+---
+fixes:
+  - Fixed documentation for log_dir parameter