Issue #13164 has been reported by Cordula Roser.
----------------------------------------
Bug #13164: puppetdoc duplicate documentation
https://projects.puppetlabs.com/issues/13164
Author: Cordula Roser
Status: Unreviewed
Priority: Normal
Assignee:
Category: documentation
Target version:
Affected Puppet version: 2.7.12rc2
Keywords:
Branch:
Hi,
we are setting up a new platform and in order to keep the code self documented
we used 'puppet doc'.
We run it with the following parameters
puppet doc --outputdir /var/www/puppet/main --mode rdoc
and for our environments
puppet doc --outputdir /var/www/puppet/${env} --mode rdoc --environment
${env}
Even if documentation of 'puppet doc' says environments are broken this is
working fine for us.
But after generation there are defines documented twice or defines in depth
four are broken at all, see attached screenshots.
The manifests related to those defines are:
/etc/puppet/environments/${env}/role/manifests/puppet/environment.pp
# == Define: role::puppet::environment
#
# Role for adding environments to puppet.conf of a puppet master, this is a
meta define, please use role::puppet::environment::global or
role::puppet::environment::user instead
#
# === Parameters
#
# [*manifestdir*]
# directory where manifests can be found for this environment
#
# [*modulepath*]
# directory where modules can be found for this environment
#
# === Variables
#
# None
#
# === Examples
#
# role::puppet::environment { 'croser':
# manifestdir => '/home/croser/puppet/manifests,
# modulepath => '/home/croser/puppet/modules'
# }
#
define role::puppet::environment($manifestdir,$modulepath)
{
include role::puppet::master
concat::fragment { "puppet.conf_environment_$name":
target => "/etc/puppet/puppet.conf",
content => template("role/puppet/puppet.conf_environment"),
order => "02",
}
}
and /etc/puppet/environments/${env}/role/manifests/puppet/environment/global.pp
# == Define: role::puppet::environment::global
#
# Role for adding customer environments to puppetmaster
#
# === Parameters
#
# [*namevar*]
# Name of a global customer environment which is placed in
/etc/puppet/environments,
# if there is a folder /etc/puppet/environments/2810_plusline it has to
be configured
# like described in the example below
#
# === Variables
#
# None
#
# === Examples
#
# role::puppet::environment::global { '2810_plusline': }
#
define role::puppet::environment::global
{
role::puppet::environment{$name:
manifestdir => "/etc/puppet/environments/$name",
modulepath => "/etc/puppet/environments/$name:/etc/puppet/modules"
}
}
Has anybody an idea what could cause this?
Regards
CR
--
You have received this notification because you have either subscribed to it,
or are involved in it.
To change your notification preferences, please click here:
http://projects.puppetlabs.com/my/account
--
You received this message because you are subscribed to the Google Groups
"Puppet Bugs" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/puppet-bugs?hl=en.
