From 8db34e691308945aa90b7b5387b077978ff7bbee Mon Sep 17 00:00:00 2001 From: txaj Date: Fri, 20 Feb 2015 08:58:16 -0700 Subject: [PATCH] Add a section to explain version scoping & known issue for #162 --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index ee6f084b7..d1d483a4a 100644 --- a/README.md +++ b/README.md @@ -815,6 +815,10 @@ class { 'collectd::plugin::zfs_arc': See metadata.json for supported platforms +##Known issues + +Some plugins will need two runs of Puppet to fully generate the configuration for collectd. See [this issue](https://github.com/pdxcat/puppet-module-collectd/issues/162). + ##Development ### Running tests @@ -830,3 +834,13 @@ bundle exec rake lint bundle exec rake validate bundle exec rake spec SPEC_OPTS='--format documentation' ``` + +### Version scoping + +Some plugins or some options in plugins are only available for recent versions of collectd. + +This module shall not use unsupported configuration directives. Look at [templates/loadplugin.conf.erb](https://github.com/pdxcat/puppet-module-collectd/blob/master/templates/loadplugin.conf.erb) for a hands-on example. + +Please make use of the search by branch/tags on the collectd github to see when a function has been first released. + +Reading the [collectd.conf.pod](https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod) file is good, validating the presence of the code in the .c files is even better. \ No newline at end of file