RFR: Follow-on update due to the introduction of caused-by links
Iris Clark
iris at openjdk.org
Thu Feb 27 00:54:05 UTC 2025
On Wed, 26 Feb 2025 20:57:39 GMT, Roger Calnan <duke at openjdk.org> wrote:
> Noted that the label regression_ID is now deprecated and a caused-by link should be used. Fixed a couple of typos
src/guide/jbs-jdk-bug-system.md line 84:
> 82: 1) If an issue is applicable to release N, then it can't be assumed that it is applicable to older releases less than N. It may be, but in general this is less important to know, as the majority of issues are only fixed in the latest feature release. If the issue is a crash or important in another way, then it becomes worthwhile to take the time to determine if it's relevant to earlier LTS releases.
> 83:
> 84: Another aspect of an issue is when the feature, it's a part of, was added or removed from the JDK, which in either case limits the range of releases the issue impacts. Knowing that a feature was removed before the oldest currently maintained release means it can be resolved as [Won't Fix]{.jbs-value}.
Maybe "... when a part of the feature was added ...". I'm not sure because that may change the intent.
src/guide/jbs-jdk-bug-system.md line 128:
> 126: 2. No need to add additional releases as they are implied.
> 127: 3. Adding the occasional LTS release value is ok.
> 128: 4. Use N-na to indicate that the issue is no longer relevant from that release, which could be due to the feature or platform being removed or the code has been rewritten.
I think that "being rewritten" was correct since it parallels the earlier "being removed".
src/guide/jbs-jdk-bug-system.md line 739:
> 737: <td class="dictionary">[[regression_]{.jbs-label}*(ID)*]{#regression_id}</td>
> 738: <td class="dictionary">
> 739: **Deprecated.** Was used to identify the fix that caused the regression, where known. Has been replaced by the use of the [caused by]{.jbs-value} link.
Maybe "**Formerly** used to identify...".
Also either "**This label** has been replaced by the use..." or "**Replaced** by the use..."
-------------
PR Review Comment: https://git.openjdk.org/guide/pull/143#discussion_r1972635376
PR Review Comment: https://git.openjdk.org/guide/pull/143#discussion_r1972636220
PR Review Comment: https://git.openjdk.org/guide/pull/143#discussion_r1972638661
More information about the guide-dev
mailing list