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

[Emanuel Peter]

On Wed, 14 May 2025 11:55:32 GMT, Roberto Castañeda Lozano <rcastanedalo at openjdk.org> wrote:

>> Emanuel Peter has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   more documentation fixes
>
> test/hotspot/jtreg/compiler/lib/template_framework/Template.java line 50:
> 
>> 48:  * filled (replaced) by different values at each Template instantiation. For example, these "holes" can
>> 49:  * be filled with different types, operators or constants. Templates can also be nested, allowing a modular
>> 50:  * use of Templates.
> 
> I suggest replacing this text with a high-level summary of what is already written in the README file (or the other way round, write a short summary in the README file and point to this file for more background).

I remember discussing with @chhagedorn about what goes in the README and what in the Java file. Personally, I think as much as possible should go into the Java file. I think @chhagedorn prefers the README. So I ended up with a bit of a compromise, putting the same introduction in both places, but doing the details in the Java file. And I think I want to keep it this way. Unless @chhagedorn is ok with it if we just remove all but the first paragraph, and only refer to the Java file docs.

What I'll do now anyway, based on your suggestion @robcasloz : link from the README to the Java file.

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

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