Release notes formatting discrepancy

[Jesper Wilhelmsson]

Hi Archie,

Moving to guide-dev which seems more appropriate for this discussion. Also including Marc who has more experience working with release notes.

/Jesper

> On 13 Apr 2023, at 15:31, Archie Cobbs <archie.cobbs at gmail.com> wrote:
> 
> Not sure where to send this question, so my apologies for any misdirection...
> 
> There seems to be some discrepancy in the syntax specification for release notes, at least with regards to backslashes.
> 
> Take JDK-8304995 <https://bugs.openjdk.org/browse/JDK-8304995> for example. The end result is supposed to contain an example that looks like this:
> 
>     public class Test {
>         interface Cafe\u0301 {
>         }
>         interface Caf\u00e9 {
>         }
>     }
> 
> Note the single backslashes in there.
> 
> The corresponding JIRA issue <https://bugs.openjdk.org/browse/JDK-8304995> description contains only single backslashes.
> 
> The JDK developer's guide says: "While the markdown won’t be rendered in JBS, you can use dingus <https://spec.commonmark.org/dingus/> to see what the release note will look like."
> 
> When the JIRA description text is copied and pasted into dingus <https://daringfireball.net/projects/markdown/dingus> (or the other dingus <https://spec.commonmark.org/dingus/>) the single blackslashes appear correctly.
> 
> However,  in the current release notes <https://jdk.java.net/21/release-notes> the backslashes are missing.
> 
> It appears that the statement "you can use dingus to see what the release note will look like" is not really correct.
> 
> Where is the breakdown here?
> 
> Thanks,
> -Archie
> 
> --
> Archie L. Cobbs

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.org/pipermail/compiler-dev/attachments/20230413/bdbddfdb/attachment-0001.htm>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: Message signed with OpenPGP
URL: <https://mail.openjdk.org/pipermail/compiler-dev/attachments/20230413/bdbddfdb/signature-0001.asc>