RFR: 8343780: Add since checker tests to the Tools area modules and add missing @since to jdk.jfr.Recording [v2]

Christian Stein cstein at openjdk.org
Fri Nov 29 11:04:39 UTC 2024


On Thu, 14 Nov 2024 01:28:15 GMT, Nizar Benalla <nbenalla at openjdk.org> wrote:

>> Can I please get a review for this PR that add tests to verify the value of `@since` tags to the Tools area modules. The test is described in this [email](https://mail.openjdk.org/pipermail/jdk-dev/2024-October/009474.html). This issue is similar to JDK-8341399, JDK-8331051 and JDK-8343442.
>> 
>> The benefit from this is helping API authors and reviewer validate the accuracy of `@since` in their source code (and subsequently, in the generated documentation). And lessen the burden on Reviewers.
>> 
>> The test has been added for `java.base` and a few other modules and has helped catch some bugs before they make it to the JDK.
>> 
>> Notes: 
>> - I have also added an `@since` tag that was missing.
>> - You will notice there is no test for the `jdk.jfr` module, it will be added in a future PR because it requires special handling. (JFR used to be a commercial feature and this requires special handling to be added for it in the test)
>> 
>> TIA
>
> Nizar Benalla has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Add backticks, as they are necessary. Otherwise the `@since` is treated as a jtreg tag
>   
>   Revert "remove backticks"
>   
>   This reverts commit 83afb011685a4bc09bc994dd9a8891f6cdfe7217.

Two nits:
- Copyright notice in `Recording.java` needs a 2024
- A missing line in a test file

test/jdk/tools/sincechecker/modules/jdk.jlink/JdkJlinkCheckSince.java line 29:

> 27:  * @summary Test for `@since` in jdk.jlink module
> 28:  * @library /test/lib /test/jdk/tools/sincechecker
> 29:  * @run main SinceChecker jdk.jlink

Missing "last" line? 
Suggestion:

 * @run main SinceChecker jdk.jlink
 */

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

Changes requested by cstein (Committer).

PR Review: https://git.openjdk.org/jdk/pull/21982#pullrequestreview-2469661625
PR Review Comment: https://git.openjdk.org/jdk/pull/21982#discussion_r1863349800


More information about the core-libs-dev mailing list