[Bug other/107297] New: Support markdown in bugzilla comments

[Bug other/107297] New: Support markdown in bugzilla comments

[jmuizelaar at mozilla dot com]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107297

            Bug ID: 107297
           Summary: Support markdown in bugzilla comments
           Product: gcc
           Version: unknown
            Status: UNCONFIRMED
          Severity: normal
          Priority: P3
         Component: other
          Assignee: unassigned at gcc dot gnu.org
          Reporter: jmuizelaar at mozilla dot com
  Target Milestone: ---

bugzilla.mozilla.org switched to this a while ago and it's a really nice
improvement.

[Bug other/107297] Support markdown in bugzilla comments

[marxin at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107297

Martin Liška <marxin at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|UNCONFIRMED                 |NEW
   Last reconfirmed|                            |2022-10-17
     Ever confirmed|0                           |1
                 CC|                            |marxin at gcc dot gnu.org

--- Comment #1 from Martin Liška <marxin at gcc dot gnu.org> ---
I do support it! Can you please link to a markdown format and how it's used?

[Bug web/107297] Support markdown in bugzilla comments

[egallager at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107297

Eric Gallager <egallager at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |egallager at gcc dot gnu.org

--- Comment #2 from Eric Gallager <egallager at gcc dot gnu.org> ---
I would also want comments to be editable if this gets turned on, in case I
screw up my formatting... is there a way to allow that in bugzilla?

[Bug web/107297] Support markdown in bugzilla comments

[pinskia at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107297

--- Comment #3 from Andrew Pinski <pinskia at gcc dot gnu.org> ---
I think for gcc I rather not support markdown because source gets mangled if
not enclosed with ' or '''.
And many folks don't use markdown especially when they are used to plain text.
C++ is the worst where < gets eaten up. This has been one of issues with github
even.

[Bug web/107297] Support markdown in bugzilla comments

[pinskia at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107297

--- Comment #4 from Andrew Pinski <pinskia at gcc dot gnu.org> ---
Being able to mark a comment or otherwise as not markdown is needed as all old
comments will be messed up that way.

[Bug web/107297] Support markdown in bugzilla comments

[jmuizelaar at mozilla dot com]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107297

--- Comment #5 from Jeff Muizelaar <jmuizelaar at mozilla dot com> ---
(In reply to Eric Gallager from comment #2)
> I would also want comments to be editable if this gets turned on, in case I
> screw up my formatting... is there a way to allow that in bugzilla?

bugzilla.mozilla.org supports editing comments. I'm not sure if it's supported
in stock Bugzilla.

(In reply to Andrew Pinski from comment #4)
> Being able to mark a comment or otherwise as not markdown is needed as all
> old comments will be messed up that way.

When bugzilla.mozilla.org enabled this, old comments were kept as plain text.


That being said, I asked about how Markdown is implemented in
bugzilla.mozilla.org:

jrmuizel:
> How is bmo's Markdown support implemented?
> Is it easy for other bugzilla instances to turn on Markdown?
glob:
It was a lot of work to implement it.  bugzilla.mozilla.org is very different
from stock Bugzilla, it won't be easy to bring to other instances.  I believe
there are plans to switch stock Bugzilla to follow BMO, but we're not directly
involved in that.

So perhaps this is not as easy to enable as I thought it would be.

[Bug web/107297] Support markdown in bugzilla comments

[redi at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107297

--- Comment #6 from Jonathan Wakely <redi at gcc dot gnu.org> ---
(In reply to Eric Gallager from comment #2)
> I would also want comments to be editable if this gets turned on, in case I
> screw up my formatting... is there a way to allow that in bugzilla?

There's a Preview tab in the editing box, which is useful for checking before
submitting.

[Bug web/107297] Support markdown in bugzilla comments

[redi at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107297

--- Comment #7 from Jonathan Wakely <redi at gcc dot gnu.org> ---
(In reply to Andrew Pinski from comment #3)
> And many folks don't use markdown especially when they are used to plain
> text. C++ is the worst where < gets eaten up. This has been one of issues
> with github even.

Yes, automatically treating plain text as markdown when moving llvm bugs to
github was terrible. Retroactively altering the presentation of old comments is
not acceptable. So let's assume old comments will not be affected in any way
(which is the case for BMO).

But there could be a checkbox (defaulting to off) to interpret the text as
markdown, so the commenter controls it. It would only affect new comments.

Since our bugzilla displays all comments in monospace font, what would be the
benefits of markdown except for displaying preformatted code blocks? Embedded
links seem like spam fuel (currently we only hyperlink URLs and magic strings
like Bug 107297 comment 6 and git revisions). It seems like this is really a
request to support rich formatting, where markdown is just the means to an end,
not the actual goal.

I selected a recent BMO bug to see how it looks:
https://bugzilla.mozilla.org/show_bug.cgi?id=1778863
New comments are indeed in proportional font, with embedded links, quote
blocks, and `code font` spans.