RFR: clarify how to set the affects versions [v4]
calnan
duke at openjdk.org
Thu Feb 29 01:41:16 UTC 2024
On Wed, 28 Feb 2024 16:49:47 GMT, Alexey Ivanov <aivanov at openjdk.org> wrote:
>> calnan has updated the pull request incrementally with one additional commit since the last revision:
>>
>> updates from feedback
>
> 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?
It does, I adjusted it a little
> 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.
actually I think that comma is fine. I also added another after the main point of the sentence
-------------
PR Review Comment: https://git.openjdk.org/guide/pull/119#discussion_r1506887775
PR Review Comment: https://git.openjdk.org/guide/pull/119#discussion_r1506887130
More information about the guide-dev
mailing list