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

8277847: Support toolGuide tag in class-level documentation #6566

Closed
wants to merge 1 commit into from

Conversation

FrauBoes
Copy link
Member

@FrauBoes FrauBoes commented Nov 25, 2021

This change adds support for the @toolGuide tag in class-level API documentation.

(A use case is the jwebserver tool, where the com.sun.net.httpserver.SimpleFileServer class provides API points for extension and customization of the underlying server and its components. Linking to the tool's man page in the class-level documentation would be beneficial.)


Progress

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

Issue

  • JDK-8277847: Support toolGuide tag in class-level documentation

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 6566

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

Using diff file

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

@bridgekeeper
Copy link

bridgekeeper bot commented Nov 25, 2021

👋 Welcome back jboes! 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.

@openjdk openjdk bot added the rfr Pull request is ready for review label Nov 25, 2021
@openjdk
Copy link

openjdk bot commented Nov 25, 2021

@FrauBoes The following labels will be automatically applied to this pull request:

  • build
  • javadoc

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

@openjdk openjdk bot added javadoc javadoc-dev@openjdk.org build build-dev@openjdk.org labels Nov 25, 2021
@mlbridge
Copy link

mlbridge bot commented Nov 25, 2021

Webrevs

Copy link
Contributor

@AlanBateman AlanBateman left a comment

Extending this to allow @toolGuide be used in class descriptions is generally useful.

@openjdk
Copy link

openjdk bot commented Nov 26, 2021

@FrauBoes 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:

8277847: Support toolGuide tag in class-level documentation

Reviewed-by: alanb, jjg

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 9 new commits pushed to the master branch:

  • 3d810ad: 8277411: C2 fast_unlock intrinsic on AArch64 has unnecessary ownership check
  • ce0234b: 8277860: PPC: Remove duplicate info != NULL check
  • 040b2c5: 8277139: Improve code readability in PredecessorValidator (c1_IR.cpp)
  • 3e798dd: 8275330: C2: assert(n->is_Root() || n->is_Region() || n->is_Phi() || n->is_MachMerge() || def_block->dominates(block)) failed: uses must be dominated by definitions
  • 99e4bda: 8277417: C1 LIR instruction for load-klass
  • 00a6238: 8277508: need to check has_predicated_vectors before calling scalable_predicate_reg_slots
  • 3383c0d: 8277659: [TESTBUG] Microbenchmark ThreadOnSpinWaitProducerConsumer.java hangs
  • 7e54d06: 8277165: jdeps --multi-release --print-module-deps fails if module-info.class in different versioned directories
  • eb4d886: 8277504: Use String.stripTrailing instead of hand-crafted method in SwingUtilities2

Please see this link for an up-to-date comparison between the source branch of this pull request and the master branch.
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.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Nov 26, 2021
@FrauBoes
Copy link
Member Author

FrauBoes commented Nov 29, 2021

/integrate

@openjdk
Copy link

openjdk bot commented Nov 29, 2021

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

  • 9a3a9b1: 8277865: G1: Change integer division to floating point division
  • aed53ee: 8264838: IGV: enhance graph export functionality
  • 0c7a4b8: 8277842: IGV: Add jvms property to know where a node came from
  • c3a7f2f: 8277382: make c1 BlockMerger use IR::verify only when necessary
  • 8f9eb62: 8274784: jshell: Garbled character was displayed by System.out.println(...) on Japanese Windows
  • e9b36a8: 8276670: G1: Rename G1CardSetFreePool and related classes
  • b9eb532: 8276685: Malformed Javadoc inline tags in JDK source in /jdk/management/jfr/RecordingInfo.java
  • 40fef23: 8275908: Record null_check traps for calls and array_check traps in the interpreter
  • 3d810ad: 8277411: C2 fast_unlock intrinsic on AArch64 has unnecessary ownership check
  • ce0234b: 8277860: PPC: Remove duplicate info != NULL check
  • ... and 7 more: https://git.openjdk.java.net/jdk/compare/987992042454f92936d3efbd01e7beb921e3b70e...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot closed this Nov 29, 2021
@openjdk openjdk bot added integrated Pull request has been integrated and removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Nov 29, 2021
@openjdk
Copy link

openjdk bot commented Nov 29, 2021

@FrauBoes Pushed as commit e3e5908.

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

@FrauBoes FrauBoes deleted the 8277847 branch Nov 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build build-dev@openjdk.org integrated Pull request has been integrated javadoc javadoc-dev@openjdk.org
4 participants