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-8264274: Block tags in overview.html are ignored #5099

Closed
wants to merge 2 commits into from

Conversation

hns
Copy link
Member

@hns hns commented Aug 12, 2021

This is a simple fix to generate block tags in overview files specified by the -overview option.

I added a protected addOverviewTags method in AbstractOverviewIndexWriter which is probably overkill but keeps things flexible and separated.


Progress

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

Issue

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 5099

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

Using diff file

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

@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Aug 12, 2021

👋 Welcome back hannesw! 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 label Aug 12, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Aug 12, 2021

@hns 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.

@openjdk openjdk bot added the javadoc label Aug 12, 2021
@mlbridge
Copy link

@mlbridge mlbridge bot commented Aug 12, 2021

Webrevs

Copy link
Contributor

@jonathan-gibbons jonathan-gibbons left a comment

src/ code looks good; test/ code has a question...

<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="%1$sp1/C.html" title="class in p1"><code>C</code></a></li>
Copy link
Contributor

@jonathan-gibbons jonathan-gibbons Aug 12, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's with the funky URL?

Copy link
Member Author

@hns hns Aug 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's just a format string specifier "%1$s", meaning the first format argument (see invocation of formatted method below to adapt the string to a module or non-module context).

I realize now that I could have omitted the argument index part of the format specifier, will update the PR if that is true.

Copy link
Contributor

@jonathan-gibbons jonathan-gibbons Aug 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doh, silly me; of course.

@openjdk
Copy link

@openjdk openjdk bot commented Aug 16, 2021

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

8264274: Block tags in overview.html are ignored

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

  • b2c272d: 8272305: several hotspot runtime/modules don't check exit codes
  • 8268825: 8272297: FileInputStream should override transferTo() for better performance
  • 3677734: 8271471: [IR Framework] Rare occurrence of "" in PrintIdeal/PrintOptoAssembly can let tests fail
  • 0a03481: 8272231: G1: Refactor G1CardSet::get_card_set to return G1CardSetHashTableValue*
  • 83d0e12: 8267833: Improve G1CardSetInlinePtr::add()
  • 69cc588: 8272235: G1: update outdated code root fixup
  • 5db36ce: 8272158: SoftReference related bugs under memory pressure
  • 7a5b37b: 8272439: G1: add documentation to G1CardSetInlinePtr
  • 0209d9f: 8272461: G1: remove empty declaration of cleanup_after_scan_heap_roots
  • 36e2dda: 8272348: Update CDS tests in anticipation of JDK-8270489
  • ... and 18 more: https://git.openjdk.java.net/jdk/compare/7e14c3cc112e109f0fc79c661eafd2fb14f22431...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.

@openjdk openjdk bot added the ready label Aug 16, 2021
@hns
Copy link
Member Author

@hns hns commented Aug 17, 2021

/integrate

@openjdk
Copy link

@openjdk openjdk bot commented Aug 17, 2021

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

  • c5c84b8: 8270312: Error: Not a test or directory containing tests: java/awt/print/PrinterJob/XparColor.java
  • df1427b: 8272446: C1: Raw version of UnsafeGet generates load barriers
  • 989f39f: 8272552: mark hotspot runtime/cds tests which ignore external VM flags
  • ee8bf10: 8272327: Shenandoah: Avoid enqueuing duplicate string candidates
  • 3fb1927: 8271227: Missing {@code } in com.sun.source.*
  • a5ad772: 8272342: [TEST_BUG] java/awt/print/PrinterJob/PageDialogMarginTest.java catches all exceptions
  • ae45592: 8272374: doclint should report missing "body" comments
  • b2c272d: 8272305: several hotspot runtime/modules don't check exit codes
  • 8268825: 8272297: FileInputStream should override transferTo() for better performance
  • 3677734: 8271471: [IR Framework] Rare occurrence of "" in PrintIdeal/PrintOptoAssembly can let tests fail
  • ... and 25 more: https://git.openjdk.java.net/jdk/compare/7e14c3cc112e109f0fc79c661eafd2fb14f22431...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot closed this Aug 17, 2021
@openjdk openjdk bot added integrated and removed ready rfr labels Aug 17, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Aug 17, 2021

@hns Pushed as commit 0e3fde6.

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

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