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-8261203: Incorrectly escaped javadoc html with type annotations #2719

Closed
wants to merge 1 commit into from

Conversation

@jonathan-gibbons
Copy link
Contributor

@jonathan-gibbons jonathan-gibbons commented Feb 25, 2021

Please review a simple change to exclude type annotations from primitive types in the id generated for a method signature.

There's a latent secondary issue, not addressed here, that quotes (") in an attribute value are not escaped correctly. That could be fixed, separately, at the cost of checking every generated attribute value. For now, at least for ids, we can avoid this issue by constraining the set of attribute values, which for ids, is now easier, in the recently-new HtmlIds class.


Progress

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

Issue

  • JDK-8261203: Incorrectly escaped javadoc html with type annotations

Reviewers

Download

$ git fetch https://git.openjdk.java.net/jdk pull/2719/head:pull/2719
$ git checkout pull/2719

@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Feb 25, 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.

@openjdk openjdk bot added the rfr label Feb 25, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Feb 25, 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.

@openjdk openjdk bot added the javadoc label Feb 25, 2021
@mlbridge
Copy link

@mlbridge mlbridge bot commented Feb 25, 2021

Webrevs

liach
liach approved these changes Feb 25, 2021
@liach
Copy link
Contributor

@liach liach commented Feb 25, 2021

As far as I see, currently, for all other types, the type annotations are not included as part of method's html anchor.

hns
hns approved these changes Feb 25, 2021
Copy link
Member

@hns hns left a comment

Looks good!

@openjdk
Copy link

@openjdk openjdk bot commented Feb 25, 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:

8261203: Incorrectly escaped javadoc html with type annotations

Reviewed-by: hannesw

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

  • f79c626: 8262296: Fix remaining doclint warnings in jdk.httpserver
  • ea48a0b: 8262163: Extend settings printout in jcmd VM.metaspace
  • a83e802: 8262299: C2 compilation fails with "modified node was not processed by IGVN.transform_old()"
  • 0f8be6e: 8261868: Reduce inclusion of metaspace.hpp
  • 3a0d6a6: 8262099: jcmd VM.metaspace should report unlimited size if MaxMetaspaceSize isn't specified

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 label Feb 25, 2021
@jonathan-gibbons
Copy link
Contributor Author

@jonathan-gibbons jonathan-gibbons commented Feb 25, 2021

/integrate

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

@openjdk openjdk bot commented Feb 25, 2021

@jonathan-gibbons Since your change was applied there have been 9 commits pushed to the master branch:

  • 2eca17d: 8261457: test/langtools/tools/javac/T8187978 can fail if ArrayList class is modified
  • c54724d: 8257234: Add gz option to SA jmap to write a gzipped heap dump
  • aa35b42: 8261131: jcmd jmap dump should not accept gz option with no value
  • ebdc80e: 8252883: AccessDeniedException caused by delayed file deletion on Windows
  • f79c626: 8262296: Fix remaining doclint warnings in jdk.httpserver
  • ea48a0b: 8262163: Extend settings printout in jcmd VM.metaspace
  • a83e802: 8262299: C2 compilation fails with "modified node was not processed by IGVN.transform_old()"
  • 0f8be6e: 8261868: Reduce inclusion of metaspace.hpp
  • 3a0d6a6: 8262099: jcmd VM.metaspace should report unlimited size if MaxMetaspaceSize isn't specified

Your commit was automatically rebased without conflicts.

Pushed as commit 674be87.

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

@jonathan-gibbons jonathan-gibbons deleted the bad-ids branch Feb 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants