Issue #22489 has been updated by Melissa Stone. Status changed from Merged - Pending Release to Closed
Released in Puppet 3.4.0-rc1 ---------------------------------------- Bug #22489: Setting descriptions get mangled https://projects.puppetlabs.com/issues/22489#change-100380 * Author: Nick Fagerlund * Status: Closed * Priority: Normal * Assignee: * Category: documentation * Target version: 3.4.0 * Affected Puppet version: * Keywords: * Branch: https://github.com/puppetlabs/puppet/pull/1890 ---------------------------------------- Puppet settings allow you to set a description, which is used to generate the [config reference](http://docs.puppetlabs.com/references/latest/configuration.html) and the commented puppet.conf from `--genconfig`. Unfortunately, all line breaks get removed. This wrecks any formatting that relies on line breaks for clarity or Markdown syntax. Compare the version of `dns_alt_names` in the config reference with the source in defaults.rb. The offending line in lib/puppet/settings/base_setting.rb is: @desc = value.gsub(/^\s*/, '') This looks like it's just supposed to trim off leading space, but it collapses newlines as well. We have a function in Puppet::Util::Docs that's designed exactly for this -- it only trims off the lowest common indent, ignoring the first line. We should just use that instead. -- 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 unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at http://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/groups/opt_out.
