PSA: Please use <pre> tags when reporting bugs.

5 views

Skip to first unread message

Nigel Kersten

unread,

Jan 23, 2011, 4:48:16 PM1/23/11

to public puppet users, public puppet dev

It's particularly difficult to understand what's going on with a given
bug report when the log/manifest/terminal output is all being
mis-interpreted as Markdown text.

We'll definitely try and make this more obvious somewhere, but it
really does help immensely if you use the <pre> and </pre> HTML tags
in your bug reports to surround manifest excerpts, log output, and
terminal commands.

It helps a lot with long log lines, as we get them inside a scrollable
container, and it clearly separates out the code/output from the
language describing the issue.

Example:

Here's my test manifest, test.pp

<pre>
class hope {
notice("I wish Puppet would do what I mean and not what I say")
}

include hope
</pre>

and here are the results when I apply it:
<pre>
kripke:~ nbk$ puppet apply -v /tmp/test.pp
notice: Scope(Class[Hope]): I wish Puppet would do what I mean and not
what I say
info: Applying configuration version '1295819244'
</pre>

Rob McBroom

unread,

Jan 27, 2011, 10:50:04 AM1/27/11

to puppet...@googlegroups.com

On Jan 23, 2011, at 4:48 PM, Nigel Kersten wrote:

> It's particularly difficult to understand what's going on with a given
> bug report when the log/manifest/terminal output is all being
> mis-interpreted as Markdown text.

If it’s being treated as Markdown, indenting such sections 4 or more spaces should also do the trick without requiring HTML tags.