summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorStefan Möding <stm@kill-9.net>2016-10-14 16:45:13 +0200
committerStefan Möding <stm@kill-9.net>2016-10-14 16:45:13 +0200
commitf947fce65e967fc95d71feb44b9e2a53c2b93a03 (patch)
treebf70765ff48425c24af0bb24e6ab2906432dbdb0 /README.markdown
parentf2492ee916c1c8e0345514045432c4a049674029 (diff)
Fix incorrect environment variable name in README
The README references the environment variable `STDLIB_LOG_DEPRECATION` while the code uses `STDLIB_LOG_DEPRECATIONS` (note the trailing S).
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.markdown b/README.markdown
index c0b3155..b41039d 100644
--- a/README.markdown
+++ b/README.markdown
@@ -358,7 +358,7 @@ deprecation(key, message)
The Puppet settings '[disable_warnings](https://docs.puppet.com/puppet/latest/reference/configuration.html#disablewarnings)', '[max_deprecations](https://docs.puppet.com/puppet/latest/reference/configuration.html#maxdeprecations)', and '[strict](https://docs.puppet.com/puppet/latest/reference/configuration.html#strict)' affect this function. Set 'strict' to `error` to fail immediately with the deprecation message, `off` to output emit no messages at all, or `warning` (default) to log all warnings.
-Additionally you can set the environment variable `STDLIB_LOG_DEPRECATION` to decide whether or not to log deprecation warnings: if this environment variable is set to `true`, the functions log a warning, if it is set to `false`, no warnings are logged. If no value is set at all, Puppet 4 will emit warnings, while Puppet 3 will not. Using this setting is especially useful for automated tests to avoid flooding your logs before you are ready to migrate.
+Additionally you can set the environment variable `STDLIB_LOG_DEPRECATIONS` to decide whether or not to log deprecation warnings: if this environment variable is set to `true`, the functions log a warning, if it is set to `false`, no warnings are logged. If no value is set at all, Puppet 4 will emit warnings, while Puppet 3 will not. Using this setting is especially useful for automated tests to avoid flooding your logs before you are ready to migrate.
*Type*: String, String.