Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JDK-8274211: Test man page that options are documented #5833

Closed

Conversation

@jonathan-gibbons
Copy link
Contributor

@jonathan-gibbons jonathan-gibbons commented Oct 6, 2021

Please review a new test to compare the set of options documented in the javadoc man page against the set of options declared in the source.

Since there is currently a disparity, an "exception" mechanism is included so that the test can pass. When the options have been added to the man page, this test is designed to fail, and the relevant strings should be removed from the MISSING_IN_MAN_PAGE list.

Test runs on all supported platforms.


Progress

  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue
  • Change must be properly reviewed

Issue

  • JDK-8274211: Test man page that options are documented

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jdk pull/5833/head:pull/5833
$ git checkout pull/5833

Update a local copy of the PR:
$ git checkout pull/5833
$ git pull https://git.openjdk.java.net/jdk pull/5833/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 5833

View PR using the GUI difftool:
$ git pr show -t 5833

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jdk/pull/5833.diff

@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Oct 6, 2021

👋 Welcome back jjg! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

Loading

@openjdk
Copy link

@openjdk openjdk bot commented Oct 6, 2021

@jonathan-gibbons The following label will be automatically applied to this pull request:

  • javadoc

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

Loading

@openjdk openjdk bot added the javadoc label Oct 6, 2021
@openjdk openjdk bot added the rfr label Oct 6, 2021
@mlbridge
Copy link

@mlbridge mlbridge bot commented Oct 6, 2021

Webrevs

Loading

Copy link
Member

@pavelrappo pavelrappo left a comment

Thank you for doing this, Jon.

Loading

test/langtools/jdk/javadoc/tool/CheckManPageOptions.java Outdated Show resolved Hide resolved
Loading
test/langtools/jdk/javadoc/tool/CheckManPageOptions.java Outdated Show resolved Hide resolved
Loading
Loading
test/langtools/jdk/javadoc/tool/CheckManPageOptions.java Outdated Show resolved Hide resolved
Loading
@openjdk
Copy link

@openjdk openjdk bot commented Oct 6, 2021

@jonathan-gibbons This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8274211: Test man page that options are documented

Reviewed-by: prappo

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 18 new commits pushed to the master branch:

  • 9561fea: 8273102: Delete deprecated for removal the empty finalize() in java.desktop module
  • 9945f7a: 8274318: Replace 'for' cycles with iterator with enhanced-for in java.management
  • 754bc82: 8274525: Replace uses of StringBuffer with StringBuilder in java.xml
  • 4e7d7ca: 8273711: Remove redundant stream() call before forEach in jdk.jlink
  • f3cedbe: 8274464: Remove redundant stream() call before forEach in java.* modules
  • c10de35: 8262944: Improve exception message when automatic module lists provider class not in JAR file
  • b8af6a9: 8273917: Remove 'leaf' ranking for Mutex
  • c80a612: 8273381: Assert in PtrQueueBufferAllocatorTest.stress_free_list_allocator_vm
  • 9759fcb: 8274496: Use String.contains() instead of String.indexOf() in java.desktop
  • cdf8930: 8274625: Search field placeholder behavior
  • ... and 8 more: https://git.openjdk.java.net/jdk/compare/83b2219220266c1365466970d08606fef766c4fa...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

Loading

@openjdk openjdk bot added the ready label Oct 6, 2021
@jonathan-gibbons
Copy link
Contributor Author

@jonathan-gibbons jonathan-gibbons commented Oct 6, 2021

/integrate

Loading

@openjdk
Copy link

@openjdk openjdk bot commented Oct 6, 2021

Going to push as commit 734d1fb.
Since your change was applied there have been 18 commits pushed to the master branch:

  • 9561fea: 8273102: Delete deprecated for removal the empty finalize() in java.desktop module
  • 9945f7a: 8274318: Replace 'for' cycles with iterator with enhanced-for in java.management
  • 754bc82: 8274525: Replace uses of StringBuffer with StringBuilder in java.xml
  • 4e7d7ca: 8273711: Remove redundant stream() call before forEach in jdk.jlink
  • f3cedbe: 8274464: Remove redundant stream() call before forEach in java.* modules
  • c10de35: 8262944: Improve exception message when automatic module lists provider class not in JAR file
  • b8af6a9: 8273917: Remove 'leaf' ranking for Mutex
  • c80a612: 8273381: Assert in PtrQueueBufferAllocatorTest.stress_free_list_allocator_vm
  • 9759fcb: 8274496: Use String.contains() instead of String.indexOf() in java.desktop
  • cdf8930: 8274625: Search field placeholder behavior
  • ... and 8 more: https://git.openjdk.java.net/jdk/compare/83b2219220266c1365466970d08606fef766c4fa...master

Your commit was automatically rebased without conflicts.

Loading

@openjdk openjdk bot closed this Oct 6, 2021
@openjdk openjdk bot added integrated and removed ready labels Oct 6, 2021
@jonathan-gibbons jonathan-gibbons deleted the 8274211.man-checker branch Oct 6, 2021
@openjdk openjdk bot removed the rfr label Oct 6, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Oct 6, 2021

@jonathan-gibbons Pushed as commit 734d1fb.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

Loading

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants