RFR: 8344942: Template-Based Testing Framework [v2]

[Emanuel Peter]

On Mon, 31 Mar 2025 08:39:36 GMT, Christian Hagedorn <chagedorn at openjdk.org> wrote:

>> Emanuel Peter has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains six additional commits since the last revision:
>> 
>>  - Merge branch 'master' into JDK-8344942-TemplateFramework-v3
>>  - fix tests
>>  - whitespace
>>  - whitespace
>>  - fix whitespace
>>  - JDK-8344942
>
> test/hotspot/jtreg/compiler/lib/template_framework/Template.java line 35:
> 
>> 33:  *
>> 34:  * <p>
>> 35:  * A {@link Template} can have zero or more arguments, and for each number of arguments there is an implementation
> 
> Since the `README` refers to this file for more information (which is perfectly fine to avoid repetition), I naturally started to read here at the top. But in this paragraph, we are already explaining details of the implementation without giving a more general introduction and motivation for the Template Framework which can leave readers without background confused. I think it could be worth to spend some more time in the README (which you can then also just refer to when suggesting to use the framework in PRs). You could cover: Why is the framework useful/why should I care about it, some leading example/testing scenario and why it is really hard to cover that without the framework (i.e. what we've done so far until today), how does the framework roughly work, how easy is it to write tests (you can then reference example tests from there) etc. 
> 
> You can still do many references from the `README` to classes and examples.
> 
> Side note: I admit that I could have extended the IR framework `README` with a more motivational introduction as well - maybe I will add that later.

I added an additional test, and copied some snippets to the java docs.
I also added some more motivation.
Let me know if that is better, or if you have any more suggestions :)

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

PR Review Comment: https://git.openjdk.org/jdk/pull/24217#discussion_r2021072263