Fix documentation for log_dir parameter

Change-Id: I280409ece958a0b2c5e25cc6ad511834b8cec47c Partial-Bug: #1600294
7 years ago · 88713c96f7
parent 33f96d71ed
commit 88713c96f7
7 changed files with 9 additions and 6 deletions
--- a/manifests/api.pp
+++ b/manifests/api.pp
@ -36,7 +36,7 @@
 #
 #  [*log_dir*]
 #    (optional) directory to which glance 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
 #
 # [*registry_host*]
--- a/manifests/api/logging.pp
+++ b/manifests/api/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/glance'.
 #
 #  [*log_file*]
--- a/manifests/cache/logging.pp
+++ b/manifests/cache/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/glance'
 #
 #  [*log_file*]
--- a/manifests/glare/logging.pp
+++ b/manifests/glare/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/glance'
 #
 #  [*log_file*]
--- a/manifests/registry.pp
+++ b/manifests/registry.pp
@ -31,7 +31,7 @@
 #
 #  [*log_dir*]
 #    (optional) directory to which glance 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.
 #
 #  [*database_connection*]
--- a/manifests/registry/logging.pp
+++ b/manifests/registry/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/glance'.
 #
 #  [*log_file*]
--- a/releasenotes/notes/fix_log_dir_documentation-0e2dcaf9a5d5c58c.yaml
+++ b/releasenotes/notes/fix_log_dir_documentation-0e2dcaf9a5d5c58c.yaml
@ -0,0 +1,3 @@
+---
+fixes:
+  - Fixed documentation for log_dir parameter