RFR: 8292911: Add a note about jtreg failure handlers in the testing doc [v2]

Erik Joelsson erikj at openjdk.org
Fri Aug 26 13:16:00 UTC 2022


On Fri, 26 Aug 2022 06:07:21 GMT, Jaikiran Pai <jpai at openjdk.org> wrote:

>> Can I please get a review of this change to the testing documentation which adds a note about failure handlers in jtreg? This addresses https://bugs.openjdk.org/browse/JDK-8292911.
>> 
>> Recently, there have been users who have been prompted for sudo password when running jtreg tests locally and those tests running into failures. This is because one of the commands that gets executed by the jtreg failure handler uses sudo (the `sudo dmesg` command on macos).
>> 
>> This commit updates the `testing.md` to explain what the failure handler does and also mentions the configuration that can be used to disable the failure handler. This commit doesn't specify how to configure the `sudoers` file if the user still wants to allow the failure handlers to run, because I thought that would be outside the scope of this documentation.
>> 
>> I attempted to auto generate the `testing.html` from the changes to `testing.md` using the `make update-build-docs` command, but that generated a lot of unnecessary diffs not just in `testing.html` but other html files in the `doc` directory. So, as suggested in a different PR which involved updates to these files, I manually added the section to the `testing.html` too.
>
> Jaikiran Pai has updated the pull request incrementally with one additional commit since the last revision:
> 
>   incorporate review comments

doc/testing.md line 55:

> 53: collecting this additional data isn't always necessary. To disable running the
> 54: failure handler, use `--enable-jtreg-failure-handler=no` when running `configure`.
> 55: If, however, you want to let the failure handler to run and don't want to be prompted

Most of this file is kept close to 80 chars per line, at least in the text blocks. Up until here, you have kept with this style, but the additions below get increasingly wider, which looks a bit weird. Would you mind tiding it up a bit?

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

PR: https://git.openjdk.org/jdk/pull/10021



More information about the build-dev mailing list