RFR: Updated AffectsVersion image [v2]

Thu Aug 7 23:10:52 UTC 2025

On Thu, 7 Aug 2025 23:06:10 GMT, Jesper Wilhelmsson <jwilhelm at openjdk.org> wrote:

>> Updated image to make case 5 look more like the previous cases.
>> Also fixed a borken link.
>
> Jesper Wilhelmsson has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains 24 commits:
> 
>  - Update jbs-jdk-bug-system.md
>    
>    Co-authored-by: Alexey Ivanov <alexey.ivanov at oracle.com>
>  - Made another pass
>  - Restore image some more
>  - Restore image
>  - Merge branch 'master' of github.com:openjdk/guide into cleanup
>  - Update src/guide/jbs-jdk-bug-system.md
>    
>    Co-authored-by: Alexey Ivanov <alexey.ivanov at oracle.com>
>  - Update src/guide/jbs-jdk-bug-system.md
>    
>    Co-authored-by: Alexey Ivanov <alexey.ivanov at oracle.com>
>  - Update src/guide/jbs-jdk-bug-system.md
>    
>    Co-authored-by: Alexey Ivanov <alexey.ivanov at oracle.com>
>  - Update src/guide/jbs-jdk-bug-system.md
>    
>    Co-authored-by: Alexey Ivanov <alexey.ivanov at oracle.com>
>  - Updated based on Alexey's comments
>  - ... and 14 more: https://git.openjdk.org/guide/compare/74b90e8e...be7d4aa9

Changes requested by aivanov (no project role).

Looks good to me, with a minor comment.

Marked as reviewed by aivanov (no project role).

src/guide/jbs-jdk-bug-system.md line 125:

> 123: ![Guidelines for setting [Affects Version/s]{.jbs-field}](affects_versions.svg)
> 124: 
> 125: 1. Affects Version contains 8 only, which means this issue is applicable to 8 and all future releases (until it's fixed).

Suggestion:

1. [Affects Version/s]{.jbs-field} contains 8 only, which means this issue is applicable to 8 and all future releases (until it's fixed).

Shall we mark-up the JBS field?

src/guide/jbs-jdk-bug-system.md line 126:

> 124: 
> 125: 1. Affects Version contains 8 only, which means this issue is applicable to 8 and all future releases (until it's fixed).
> 126: 2. Affects Version contains 8, 8u40, 9, and 12, yet 8 already implies that the later releases are affected.

I used strike-through to indicate 8u40, 9, and 12 aren't need, which could also be confusing. Therefore, it makes to explicitly state that 8u40, 9, and 12 should not be added to the Affects Version field.

src/guide/jbs-jdk-bug-system.md line 127:

> 125: 1. Affects Version contains 8 only, which means this issue is applicable to 8 and all future releases (until it's fixed).
> 126: 2. Affects Version contains 8, 8u40, 9, and 12, yet 8 already implies that the later releases are affected.
> 127: 3. Adding the occasional LTS release value is ok.

We should expand the description of case (3) in a similar way:

Suggestion:

3. [Affects Version/s]{.jbs-field} contains 11 and 21. Adding the occasional LTS release version (21 in this example) is fine; 17 is implicitly affected as well as versions after 21.

src/guide/jbs-jdk-bug-system.md line 127:

> 125: 1. [Affects Version/s]{.jbs-field} contains [8]{.jbs-value} only, which means this issue is applicable to JDK 8 and all releases thereafter (until it's fixed).
> 126: 2. [Affects Version/s]{.jbs-field} contains [8]{.jbs-value}, [8u40]{.jbs-value}, [9]{.jbs-value}, and [12]{.jbs-value}. Since [8]{.jbs-value} already implies that later releases are affected, adding other versions are discouraged.
> 127: 3. [Affects Version/s]{.jbs-field} contains [11]{.jbs-value} and [21]{.jbs-value}. Adding occasional versions for actively maintained JDK releases (JDK 21 in this example) is fine; JDK 17 is implicitly affected as well as releases after JDK 21.

Suggestion:

3. [Affects Version/s]{.jbs-field} contains [11]{.jbs-value} and [21]{.jbs-value}. Adding occasional versions of actively maintained JDK releases (JDK 21 in this example) is fine; JDK 17 is implicitly affected as well as releases after JDK 21.

I think “of” suits better here.

src/guide/jbs-jdk-bug-system.md line 128:

> 126: 2. Affects Version contains 8, 8u40, 9, and 12, yet 8 already implies that the later releases are affected.
> 127: 3. Adding the occasional LTS release value is ok.
> 128: 4. Affects Version contains 8 and the issue is fixed in 11. The 12-na label indicates that the issue is not applicable to 12 and subsequent versions.

Suggestion:

4. Affects Version contains 8 and the issue is fixed in 11. The [12-na]{.jbs-label} label indicates that the issue is not applicable to 12 and subsequent versions.

src/guide/jbs-jdk-bug-system.md line 129:

> 127: 3. Adding the occasional LTS release value is ok.
> 128: 4. Affects Version contains 8 and the issue is fixed in 11. The 12-na label indicates that the issue is not applicable to 12 and subsequent versions.
> 129: 5. Affects Version contains 8, the issue is fixed in 21 and is backported to 17. The label 11-wnf indicates that the fix will not be backported to 11 or 8.

Suggestion:

5. Affects Version contains 8, the issue is fixed in 21 and is backported to 17. The [11-wnf]{.jbs-label} label indicates that the fix will not be backported to 11 or 8.

Mark up the label; I also moved the words for consistency with case 4.

src/images/affects_versions.svg line 1:

> 1: <?xml version="1.0" encoding="UTF-8" standalone="no"?>

Why is 12-na displayed below the affects-versions line? I think the text label should stay aligned to 8 on the left.

Aligning both 12-na and 11-wnf would make the image more appealing (which I did in my version). Yet it may look confusing.

Either way, bullet 5 below the image needs updating to clarify what it illustrates.

https://github.com/openjdk/guide/blob/71fbb94b0b7b3ca75869bc158805971a3fe3d3df/src/guide/jbs-jdk-bug-system.md?plain=1#L129

-------------

PR Review: https://git.openjdk.org/guide/pull/149#pullrequestreview-2802947050
PR Review: https://git.openjdk.org/guide/pull/149#pullrequestreview-3079838063
Marked as reviewed by aivanov (no project role).

PR Review: https://git.openjdk.org/guide/pull/149#pullrequestreview-3093705101
PR Review: https://git.openjdk.org/guide/pull/149#pullrequestreview-3093728812
PR Review Comment: https://git.openjdk.org/guide/pull/149#discussion_r2248376696
PR Review Comment: https://git.openjdk.org/guide/pull/149#discussion_r2248380714
PR Review Comment: https://git.openjdk.org/guide/pull/149#discussion_r2248387497
PR Review Comment: https://git.openjdk.org/guide/pull/149#discussion_r2257921100
PR Review Comment: https://git.openjdk.org/guide/pull/149#discussion_r2248388743
PR Review Comment: https://git.openjdk.org/guide/pull/149#discussion_r2248390747
PR Review Comment: https://git.openjdk.org/guide/pull/149#discussion_r2066049224