New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

collectd.conf man page is contradictory #715

Closed
brandentimm opened this Issue Aug 25, 2014 · 2 comments

Comments

Projects
None yet
3 participants
@brandentimm

brandentimm commented Aug 25, 2014

The collectd.conf man page is contradictory/ambiguous as to the issue of ordering LoadPlugin options and blocks.

  1. SYNOPSIS uses a <Plugin df> block in the absence of "LoadPlugin df". Under the default settings for AutoLoadPlugin, this would fail.
  2. DESCRIPTION states "the LoadPlugin option must occur before the appropriate <Plugin ...> block", however this is only true for the default setting (false) for AutoLoadPlugin. This also makes SYNOPSIS more confusing.
  3. The AutoLoadPlugin section then correctly states that "LoadPlugin" is only necessary if AutoLoadPlugin is set to false (the default).

I know this is a bit of nit picking, but as a first time user reading the docs it was immediately confusing, especially because DESCRIPTION makes SYNOPSIS look like invalid syntax, until you skim far enough to see the AutoLoadPlugin option.

octo added a commit that referenced this issue Aug 27, 2014

collectd.conf(5): Improve documentation of LoadPlugin.
Mention AutoLoadPlugin in the relevant places. Add a <Plugin /> block
for the "df" plugin to make it easier to spot that it is preceded by a
<LoadPlugin /> *block*.

Fixes: #715
@octo

This comment has been minimized.

Show comment
Hide comment
@octo

octo Aug 27, 2014

Member

Hi Branden,

thanks for reporting this issue! I think I've addressed this in the referenced commit. Do you think that is sufficient?

—octo

Member

octo commented Aug 27, 2014

Hi Branden,

thanks for reporting this issue! I think I've addressed this in the referenced commit. Do you think that is sufficient?

—octo

@brandentimm

This comment has been minimized.

Show comment
Hide comment
@brandentimm

brandentimm Aug 27, 2014

Looks great!

brandentimm commented Aug 27, 2014

Looks great!

@mfournier mfournier closed this Aug 27, 2014

octo added a commit that referenced this issue Aug 29, 2014

collectd.conf(5): Improve AutoLoadPlugin documentation.
Make it clear that plugins without a <Plugin /> block will still need a
LoadPlugin line.

References: #715
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment