RFR: 8342734: GenShen: Test failure gc/shenandoah/TestReferenceRefersToShenandoah.java#generational

[Y. Srinivas Ramakrishna]

On Thu, 24 Oct 2024 21:56:02 GMT, William Kemper <wkemper at openjdk.org> wrote:

> Recent change introduced a regression: https://bugs.openjdk.org/browse/JDK-8342560 that caused old regions to not belong to global collections.

The change looks good; sorry for missing the change (or at least asking about it) in the previous PR.

I do have a couple of documentation requests just to make this method more easy to understand and to prevent future bugs from changes here.
1. Provide a 1-line documentation comment for the `is_in_active_generation(oop)` method in the `.hpp` file.
2. Change the comments at lines 372, 375, 378, instead of "Foo regions are in bar and baz generations, not in foobar generation", say something like "Foo regions are included in bar and baz _GCs_, not in foobar _GCs_"

I think that will make the comments easier to read and the method easier to understand (and maintain).

Since the suggestion is how to improve documentation to improve readability/maintainability, any changes to documentation comments that you make do not require my re-review/approval.

Reviewed.

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

Marked as reviewed by ysr (Committer).

PR Review: https://git.openjdk.org/shenandoah/pull/527#pullrequestreview-2393837830