Conversation
|
👋 Welcome back jnordstrom! A progress list of the required criteria for merging this PR into |
|
❗ This change is not yet ready to be integrated. |
Webrevs
|
JesperIRL
left a comment
JesperIRL
left a comment
There was a problem hiding this comment.
Thank you for picking this up! This is an area that has been in need of improvement for some time and therefore I have a few comments that has built up over time :-)
src/guide/jbs-jdk-bug-system.md
Outdated
| 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 Version/s]{.jbs-field}, it is not relevant to JDK 8. Also see [Usage of the (Rel)[-wnf]{.jbs-label} Label](#usage-of-the-rel-wnf-label) | ||
| - add multiple [-na]{.jbs-label} labels: you only need one, for example don't add both [9-na]{.jbs-label} and [11-na]{.jbs-label} — [9-na]{.jbs-label} implies all following releases therefore [11-na]{.jbs-label}, or [17-na]{.jbs-label} etc. are not needed. | ||
| - Don't use the label to indicate that a bug is not relevant to an earlier release. If for example [Affects Version/s]{.jbs-field} is [11.0.20]{.jbs-value}, [17]{.jbs-value} 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 Version/s]{.jbs-field}, it is not relevant to JDK 8. Also see [Usage of the (Rel)[-wnf]{.jbs-label} Label](#usage-of-the-rel-wnf-label) | ||
| - Never add multiple [-na]{.jbs-label} labels: you only need one. For example don't add both [9-na]{.jbs-label} and [11-na]{.jbs-label} — the [9-na]{.jbs-label} label implies all following releases therefore [11-na]{.jbs-label}, or [17-na]{.jbs-label} etc. are not needed. |
There was a problem hiding this comment.
I think the : can be replaced with a ,
There was a problem hiding this comment.
I removed then entire "you only need one". It's implied when you shouldn't add multiple. Or it good to be extra clear here?
| * [Affects Version/s]{.jbs-field} should never use any of the "special" values available in JBS like [tbd]{.jbs-value}, [na]{.jbs-value}, [unknown]{.jbs-value}, [(Rel)-pool]{.jbs-value} or similar. Only actual JDK release numbers should be used. If you want to reflect that an issue is relevant to an older release, use a family release value or an exact release if you know where the issue was introduced: [8]{.jbs-value}, [17]{.jbs-value}, [21.0.4]{.jbs-value}. | ||
|
|
||
| #### Usage of the (Rel)-na Label | ||
| #### Use (Rel)-na Label if a bug doesn't affect a release |
There was a problem hiding this comment.
Will the quotation mark affect the link on some weird way?
Used the anchor #use-rel-na-label-if-a-bug-doesnt-affect-a-release for this.
There was a problem hiding this comment.
Right, most non-letter characters will simply be cut from the link. There are a few commas and question marks in headers already if you want some examples :-)
For this header, I think there is a "the" missing: "Use the (Rel)-na..."
| - It's not recommended to specify update releases like 17u4 or 21u in the label. Labels like [17-na]{.jbs-label} and [21-na]{.jbs-label} are in general enough. | ||
|
|
||
| #### Usage of the (Rel)-wnf Label | ||
| #### Use (Rel)-wnf Label when a bug won't be fixed in a release |
There was a problem hiding this comment.
Changed header name, used anchor #use-rel-wnf-label-when-a-bug-wont-be-fixed-in-a-release.
There was a problem hiding this comment.
Similar to the other header, add a "the".
| - Don't use the label to indicate that a bug is not relevant to an earlier release. If for example [Affects Version/s]{.jbs-field} is [11.0.20]{.jbs-value}, [17]{.jbs-value} the label [8-na]{.jbs-label} would not be needed. Since the bug doesn't have [Affects Version/s]{.jbs-field} [8]{.jbs-value} or earlier, it is not relevant to JDK 8. See also how to [use (Rel)-[wnf]{.jbs-label} Label when a bug won't be fixed in a release](#use-rel-wnf-label-when-a-bug-wont-be-fixed-in-a-release). | ||
|
|
||
| Don't: | ||
| - Never add multiple [-na]{.jbs-label} labels. For example don't add both [9-na]{.jbs-label} and [11-na]{.jbs-label} — the [9-na]{.jbs-label} label implies all following releases therefore [11-na]{.jbs-label}, or [17-na]{.jbs-label} etc. are not needed. |
There was a problem hiding this comment.
"the 9-na label implies all following releases therefore 11-na, or 17-na etc. are not needed." reads a bit weird. Should there be a comma after "releases"? Or maybe even a period? Maybe the "are" should move? "Therefore are 11-na, or 17-na etc. not needed."
2 participants
Clarification for the Affects version section
Progress
Reviewing
Using
gitCheckout this PR locally:
$ git fetch https://git.openjdk.org/guide.git pull/170/head:pull/170$ git checkout pull/170Update a local copy of the PR:
$ git checkout pull/170$ git pull https://git.openjdk.org/guide.git pull/170/headUsing Skara CLI tools
Checkout this PR locally:
$ git pr checkout 170View PR using the GUI difftool:
$ git pr show -t 170Using diff file
Download this PR as a diff file:
https://git.openjdk.org/guide/pull/170.diff
Using Webrev
Link to Webrev Comment