RFR: JDK-8274211: Test man page that options are documented [v2]

Pavel Rappo prappo at openjdk.java.net
Thu Oct 7 09:31:17 UTC 2021


On Wed, 6 Oct 2021 22:25:08 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

> I'm not sure I agree that we are primarily out to sure that 1-1 correspondence between the doc sources ... that would not detect an option that was erroneously missing from both doc sources. IMO, we are primarily out to ensure that the docs match the implementation, not any other docs.

If that is true, then we should consider a pairwise comparison; for example: man page <-> help output AND help output <-> implementation. Of these two comparisons, comparing the man page with the help output would also be a good black-box test.

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

PR: https://git.openjdk.java.net/jdk/pull/5833


More information about the javadoc-dev mailing list