RFR: Initial section on testing [v6]
Erik Helin
ehelin at openjdk.java.net
Tue Oct 20 12:11:18 UTC 2020
On Tue, 20 Oct 2020 10:50:28 GMT, Jesper Wilhelmsson <jwilhelm at openjdk.org> wrote:
>> It's a start.
>
> Jesper Wilhelmsson has updated the pull request incrementally with one additional commit since the last revision:
>
> Link to html version of testing docs
I don't have any particular comments on text itself, but IMO we shouldn't use a third-party markdown rendering service
for links in OpenJDK documentation. I suggest to either link directly to HTML content hosted on
<https://openjdk.java.net> or link to the markdown source files in the [jdk](https://github.com/openjdk/jdk) repository.
src/index.md line 340:
> 338: In addition to your own Java applications, OpenJDK have support for two test frameworks, JTReg and GTest. JTReg is
> a Java regression test framework that is used for most of the tests that are included in the OpenJDK source repository.
> The Google Test (GTest) framework is intended for unit testing of the C++ native code. Currently only JVM testing is
> supported by the GTest framework. Other areas use JTReg for unit testing of C++ code. 339: 340: This section provides
> a brief summary of how to get started with testing in OpenJDK. For more information on configuration and how to use the
> OpenJDK test framework, a.k.a. "run-test framework", see
> [`doc/testing.md`](https://htmlpreview.github.io/?https://github.com/openjdk/jdk/blob/master/doc/testing.html).
Suggestion:
This section provides a brief summary of how to get started with testing in OpenJDK. For more information on
configuration and how to use the OpenJDK test framework, a.k.a. "run-test framework", see
[`doc/testing.html`](https://openjdk.java.net/groups/build/doc/testing.html).
src/index.md line 453:
> 451: `ASSERT` is a fatal assertion and will interrupt execution of the current sub-routine. `EXPECT` is a nonfatal
> assertion and will report the error but continues to run the test. All assertions have both an `ASSERT` and an `EXPECT`
> variant. 452: 453: For more information on how to write good GTests in HotSpot, see
> [`doc/hotspot-unit-tests.md`](https://htmlpreview.github.io/?https://github.com/openjdk/jdk/blob/master/doc/hotspot-unit-tests.html).
Suggestion:
For more information on how to write good GTests in HotSpot, see
[`doc/hotspot-unit-tests.md`](https://github.com/openjdk/jdk/blob/master/doc/hotspot-unit-tests.md).
-------------
PR: https://git.openjdk.java.net/guide/pull/30
More information about the guide-dev
mailing list