Integrated: JDK-8319139: Improve diagnosability of `JavadocTester` output
Jonathan Gibbons
jjg at openjdk.org
Wed Nov 1 15:37:11 UTC 2023
On Tue, 31 Oct 2023 20:13:22 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:
> Please review a small update to the output generated by `JavadocTester` when a test fails.
>
> Although `JavadocTester` does report a stack trace, it appears after all the content of the failure message, which may be some distance away if the message is long.
>
> The `String message` parameter for `passed` and `failed` is split in two: `String message, String... details` with the intent that the `message` should be a short one-line message, and any long additional info put in the effectively optional `details`.
>
> The stack trace is now generated immediately after the initial `FAILED: `_message_ line and before the `details`.
> Using a varargs `details` means that we do not have to concatenate strings with `\n`.
>
> There are some other minor tweaks to the output to make it slightly less cryptic.
>
> `JavadocTester` does have some specific tests of its own, and these are updated as appropriate.
This pull request has now been integrated.
Changeset: 3660a90a
Author: Jonathan Gibbons <jjg at openjdk.org>
URL: https://git.openjdk.org/jdk/commit/3660a90ad8658f86f137de5955c0ae6df2c85c4f
Stats: 81 lines in 3 files changed: 26 ins; 3 del; 52 mod
8319139: Improve diagnosability of `JavadocTester` output
Reviewed-by: hannesw
-------------
PR: https://git.openjdk.org/jdk/pull/16436
More information about the javadoc-dev
mailing list