Bug #1523

In-line documentation in "$EXECUTABLE --genconfig" are incorrect

Added by Oliver Hookins over 3 years ago. Updated over 3 years ago.

Status:Closed Start date:08/21/2008
Priority:Normal Due date:
Assignee:- % Done:

0%
Category:executables
Target version:0.24.6
Affected Puppet version:0.24.4 Branch:
Keywords:
Votes: 0

Description

When you generate an example config using, for example, “puppetmasterd —genconfig” the following commented section is at the top of the file:

Note also that the section names are entirely for human-level organizational

purposes; they don’t provide separate namespaces. All parameters are in a

single namespace.

This is untrue and misleading, as section names are for per-executable configuration items. This section of comments is generated with any executable that supports —genconfig

History

#1
Updated by AJ Christensen over 3 years ago

ohookins wrote:

When you generate an example config using, for example, “puppetmasterd —genconfig” the following commented section is at the top of the file:

Note also that the section names are entirely for human-level organizational

purposes; they don’t provide separate namespaces. All parameters are in a

single namespace.

This is untrue and misleading, as section names are for per-executable configuration items. This section of comments is generated with any executable that supports —genconfig

14:01 < lak> the term 'section' means something else there
14:01 < lak> so that statement is correct, but it should be removed, because (as you are finding) it's confusing
             people
14:02 < fujin> hehe
14:02 < jamesturnbull> lak: okay will do

#2
Updated by James Turnbull over 3 years ago

  • Status changed from Unreviewed to Closed
  • Target version set to 0.24.6

Pushed in commit:c5fb092 in branch 0.24.x

Also available in: Atom PDF