RFR: Initial section on testing [v2]
Igor Ignatyev
iignatyev at openjdk.java.net
Mon Oct 19 21:03:15 UTC 2020
On Mon, 19 Oct 2020 19:23:29 GMT, Jesper Wilhelmsson <jwilhelm at openjdk.org> wrote:
>> src/index.md line 348:
>>
>>> 346: /*
>>> 347: * @test
>>> 348: * @summary Make sure feature X handles Y correctly
>>
>> b/c one might not realize that implicit `@run` exists only if there are no other `@run` tags, jtreg tests w/o `@run`
>> can (and indeed did in the past) cause confusing and effective make test useless when someone decides to add `@compile`
>> tags or other _auxilary_ tags, thus in most cases, such test descriptions should be considered as anti-patterns and
>> avoided (despite the fact that there are numbers of such test descriptions in our testbases).
>
> Excellent comment! This is exactly the kind of information that needs to be documented. I see no mention of this is
> the documents in /doc/ so I've added a sentence about this here. There's another example that I was thinking about but
> I can't recall right now - there's some tag that if specified needs to be placed before the first @run tag. I have it
> on some wiki page somewhere so it will turn up eventually :-)
I guess you are thinking about `@library`, `@library` tag must be before any `@run` tags, which include `@build`,
`@compile`, `@ignore` tags.
-------------
PR: https://git.openjdk.java.net/guide/pull/30
More information about the guide-dev
mailing list