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

8314448: Coordinate DocLint and JavaDoc to report on unknown tags #15345

Closed
wants to merge 10 commits into from

Conversation

pavelrappo
Copy link
Member

@pavelrappo pavelrappo commented Aug 18, 2023

Please review this bug fix for reporting on unknown javadoc tags.

Aside from a somewhat irrelevant test for DocLint1, there are no direct tests for reporting on unknown javadoc tags. That reporting, as it turns out, is ridden with bugs. This PR fixes quite a few of those bugs and adds missing tests.

Note, that a test for miscased tags (i.e. "{0} is an unknown tag -- same as a known tag except for case") is not added, as the matching mechanism is to be superseded by a more general one, based on a string distance function, in JDK-8288660.

Also note, that while javadoc emits a warning on an unknown tag, DocLint emits an error. I haven't changed warning to error in javadoc for (better) backward compatibility. This way, an unknown tag won't fail javadoc run (unless of course -Werror is specified). That said, in the future this decision may be revised.


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-8314448: Coordinate DocLint and JavaDoc to report on unknown tags (Bug - P4)

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/15345/head:pull/15345
$ git checkout pull/15345

Update a local copy of the PR:
$ git checkout pull/15345
$ git pull https://git.openjdk.org/jdk.git pull/15345/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 15345

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/15345.diff

Webrev

Link to Webrev Comment

Footnotes

  1. test/langtools/tools/doclint/CustomTagTest.java

Tag name cannot contain `@`. This is likely a leftover from
the previous doclet incarnation, the one that was before
cf406de.
Sure, that check could be more performant, but it will also be less
readable. The commit also fixes a test that used a nonconforming taglet.
allTaglets' keys already contain all standardTags; as a bonus that also
allows us to get rid of null check.
Ensures that _exactly one_ of them reports an unknown tag.
Again: not both, not neither.
This is how it should've been done in 8314213 (6f1071f) initially.
@bridgekeeper
Copy link

bridgekeeper bot commented Aug 18, 2023

👋 Welcome back prappo! 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 Aug 18, 2023
@openjdk
Copy link

openjdk bot commented Aug 18, 2023

@pavelrappo 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 javadoc-dev@openjdk.org label Aug 18, 2023
@mlbridge
Copy link

mlbridge bot commented Aug 18, 2023

Webrevs

Comment on lines +355 to +361
String name = switch (tag.getKind()) {
case UNKNOWN_INLINE_TAG -> ((InlineTagTree) tag).getTagName();
case UNKNOWN_BLOCK_TAG -> ((BlockTagTree) tag).getTagName();
default -> tag.getKind().tagName;
};
if (name == null) {
continue;
continue; // not a tag
Copy link
Contributor

Choose a reason for hiding this comment

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

There is room for future evolution of the DocTree API here.

@openjdk
Copy link

openjdk bot commented Aug 18, 2023

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

8314448: Coordinate DocLint and JavaDoc to report on unknown tags

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

  • bcba5e9: 8313419: Template interpreter produces no safepoint check for return bytecodes
  • c36e009: 8308984: Relativize last_sp (and top_frame_sp) in interpreter frames
  • fdac6a6: 8312180: (bf) MappedMemoryUtils passes incorrect arguments to msync (aix)
  • 7521211: 8314265: Fix -Wconversion warnings in miscellaneous runtime code

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 Aug 18, 2023
@pavelrappo
Copy link
Member Author

/integrate

@openjdk
Copy link

openjdk bot commented Aug 18, 2023

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

  • bcba5e9: 8313419: Template interpreter produces no safepoint check for return bytecodes
  • c36e009: 8308984: Relativize last_sp (and top_frame_sp) in interpreter frames
  • fdac6a6: 8312180: (bf) MappedMemoryUtils passes incorrect arguments to msync (aix)
  • 7521211: 8314265: Fix -Wconversion warnings in miscellaneous runtime code

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Aug 18, 2023
@openjdk openjdk bot closed this Aug 18, 2023
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Aug 18, 2023
@openjdk
Copy link

openjdk bot commented Aug 18, 2023

@pavelrappo Pushed as commit aecbb1b.

💡 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 Pull request has been integrated javadoc javadoc-dev@openjdk.org
2 participants