RFR: clarify how to set the affects versions [v4]

Alexey Ivanov aivanov at openjdk.org
Wed Feb 28 16:53:54 UTC 2024


On Wed, 28 Feb 2024 16:28:05 GMT, calnan <duke at openjdk.org> wrote:

>> moved together information on how the set the affects version and the meaning of the (Rel)-na and (Rel)-wnf labelss
>
> calnan has updated the pull request incrementally with one additional commit since the last revision:
> 
>   updates from feedback

Formatting looks correct now.

I've got a couple of suggestions though.

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

> 104: 
> 105: - use the label to indicate that a bug is not relevant to an earlier release, for example<br>[Affects Version]{.jbs-field}: [11.0.20]{.jbs-value}, [17]{.jbs-value}<br> the label [8-na]{.jbs-label} would not be needed - as it doesn't have a JDK 8 release, or earlier, value in the [Affects Versions]{.jbs-field}, it is not relevant to JDK 8.
> 106: - add multiple [-na]{.jbs-label} labels: you only need one, for example both these labels are not needed together '[9-na]{.jbs-label}, [11-na]{.jbs-label}' - [11-na]{.jbs-label} is not needed, as [9-na]{.jbs-label} implies all following releases.

Suggestion:

- add multiple [-na]{.jbs-label} labels: you only need one, for example adding both [9-na]{.jbs-label} and [11-na]{.jbs-label} is never needed — [9-na]{.jbs-label} implies all following releases therefore [11-na]{.jbs-label} is not needed.

Does it sound clearer?

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

> 210:     * In addition to the version where the bug was found, take special care to also investigate if the bug affects mainline.
> 211:       * See [Indicating what releases an issue is applicable to](#indicating-what-releases-an-issue-is-applicable-to) for more details.
> 212:     * For enhancements the [Affects Version]{.jbs-field} should be empty unless you feel that it is only relevant to a particular release family, and should not go into a future mainline release.

Suggestion:

    * For enhancements the [Affects Version]{.jbs-field} should be empty unless you feel that it is only relevant to a particular release family and should not go into a future mainline release.

You agreed there should be no comma here.

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

Changes requested by aivanov (no project role).

PR Review: https://git.openjdk.org/guide/pull/119#pullrequestreview-1906756163
PR Review Comment: https://git.openjdk.org/guide/pull/119#discussion_r1506276850
PR Review Comment: https://git.openjdk.org/guide/pull/119#discussion_r1506267047


More information about the guide-dev mailing list