JDK-8274211 : Test man page that options are documented
  • Type: Bug
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 17
  • Priority: P4
  • Status: Resolved
  • Resolution: Fixed
  • Submitted: 2021-09-23
  • Updated: 2024-05-28
  • Resolved: 2021-10-06
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
JDK 17 JDK 18
17.0.10-oracleFixed 18 b19Fixed
Related Reports
Relates :  
JDK-8274295 - Update the javadoc man page to reflect JDK 17 changes
Description
We should create a test that ensures that options are documented in man pages.

For now, we can scrape the info from the `.1` file. Ideally, we should eventually read the `.md` file. Perhaps the test can be written up front to accept either, defaulting to the `.1` file.
Comments
Fix request [17u] I backport this for parity with 17.0.10-oracle. No risk, only a test change. Clean backport. Test passes. SAP nightly testing passed.
26-09-2023
A pull request was submitted for review. URL: https://git.openjdk.org/jdk17u-dev/pull/1782 Date: 2023-09-25 08:20:57 +0000
25-09-2023
Changeset: 734d1fbd Author: Jonathan Gibbons <jjg@openjdk.org> Date: 2021-10-06 22:40:44 +0000 URL: https://git.openjdk.java.net/jdk/commit/734d1fbd33be0aa20b26e6e8c776709f478069de
06-10-2021
Seek, and ye shall find: Error: The following options are defined by the tool or doclet, but not defined in the man page: --legal-notices, --link-platform-properties, --no-platform-links, --since, --since-label, --snippet-path
05-10-2021
Linked the issue that describes the situation that influenced this bug.
24-09-2021