Skip to content

8252882: Clean up jdk.javadoc and the related parts of jdk.compiler #148

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

Closed
wants to merge 4 commits into from

Conversation

pavelrappo
Copy link
Member

@pavelrappo pavelrappo commented Sep 14, 2020

Yet another cleanup change that has accumulated during my work on DocCommentParser and other javadoc-related areas of compiler.


Progress

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

Issue

  • JDK-8252882: Clean up jdk.javadoc and the related parts of jdk.compiler

Reviewers

Download

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

…oops. Those conditions guard against infinite loops. Perhaps in the future we should use `boolean notEOF() { return bp < buflen; }` instead. The only naked `while` loop left is in `erroneous(...)`; that method needs to be revisited anyway. I suspect it's not rolling back correctly.

2. Added several assisting `assert` statements.
3. FQNs for `java.util.List` and `javax.lang.model.element.Name` were dropped (those are covered by the *existing* imports).
4. The result of `splitBody(fullBody)` is not used, and the call doesn't seem to have side effects. Furthermore, it is called inside `newDocCommentTree`.
5. Got rid of some casts by using a more specific type in `com.sun.tools.javac.parser.DocCommentParser.inlineText`
}" is case-insensitive when passed on a command line.)
@bridgekeeper
Copy link

bridgekeeper bot commented Sep 14, 2020

👋 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 Sep 14, 2020
@openjdk
Copy link

openjdk bot commented Sep 14, 2020

@pavelrappo The following labels will be automatically applied to this pull request: compiler 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 (add|remove) "label" command.

@openjdk openjdk bot added javadoc javadoc-dev@openjdk.org compiler compiler-dev@openjdk.org labels Sep 14, 2020
@mlbridge
Copy link

mlbridge bot commented Sep 14, 2020

Webrevs

@pavelrappo
Copy link
Member Author

/test tier1 tier2 tier3

@openjdk
Copy link

openjdk bot commented Sep 14, 2020

@pavelrappo the test group tier1 tier2 tier3 does not exist

@pavelrappo
Copy link
Member Author

/test tier1

@openjdk
Copy link

openjdk bot commented Sep 14, 2020

A test job has been started with id: github.com-149121954-148-691942047

@openjdk
Copy link

openjdk bot commented Sep 14, 2020

@pavelrappo your test job with id github.com-149121954-148-691942047 for commits up until acb118a has finished.

@mlbridge
Copy link

mlbridge bot commented Sep 14, 2020

Mailing list message from Jonathan Gibbons on compiler-dev:

On 9/14/20 7:11 AM, Pavel Rappo wrote:

I was hoping to use the `assert` facility for the purposes it was designed for. That particular occurrence of `assert`
as well as others in this pull request are about asserting that **our code** is being correct rather than input being
correct. The invariants those assertions establish MUST hold regardless of the input.

Assert/assert in all its forms should only be used to assert that our
code is correct. It is (and always has been) an anti-pattern to use it
for asserting that input is correct, whether that is user input, illegal
arguments, etc.

As Jan explained at one point, the use of the Assert class is to better
manage failures in case our code was incorrect, by failing-fast at
well-defined, instead of carrying on regardless, until the code fell
over for downstream reasons.

-- Jon

@pavelrappo
Copy link
Member Author

/test tier1

@openjdk
Copy link

openjdk bot commented Sep 14, 2020

A test job has been started with id: github.com-149121954-148-692159993

@openjdk
Copy link

openjdk bot commented Sep 14, 2020

@pavelrappo This change now passes all automated pre-integration checks. In addition to the automated checks, the change must also fulfill all project specific requirements

After integration, the commit message will be:

8252882: Clean up jdk.javadoc and the related parts of jdk.compiler

Reviewed-by: vromero
  • If you would like to add a summary, use the /summary command.
  • To credit additional contributors, use the /contributor command.
  • To add additional solved issues, use the /issue command.

Since the source branch of this PR was last updated there have been 57 commits pushed to the master branch:

  • 68da63d: 8240658: Code completion not working for lambdas in method invocations that require type inference
  • b05290a: 8252898: remove bulk registration of JFR CompilerPhaseType names
  • 779d2c3: 8253084: Zero VM is broken after JDK-8252689
  • 07da3a1: 8253030: ZGC: Change ZMarkCompleteTimeout unit to microseconds
  • f978f6f: 8252689: Classes are loaded from jrt:/java.base even when CDS is used
  • c5e63b6: 8248186: Move CDS C++ vtable code to cppVtables.cpp
  • 03a4df0: 8244778: Archive full module graph in CDS
  • 998ce78: 8252543: [JVMCI] Libgraal can deadlock in blocking compilation mode
  • b1b0f0b: 8253066: typo in Stream.mapMulti
  • 306b166: 8253033: CheckUnhandledOops check fails in ThreadSnapshot::initialize…
  • ... and 47 more: https://git.openjdk.java.net/jdk/compare/8d6d43c33b0d4b757addafae12739e60e785e53f...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid automatic rebasing, please merge master into your branch, and then specify the current head hash when integrating, like this: /integrate 68da63dcdead52418b41f80d381b105ce71a8162.

➡️ 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 Sep 14, 2020
@openjdk
Copy link

openjdk bot commented Sep 14, 2020

@pavelrappo your test job with id github.com-149121954-148-692159993 for commits up until 67fa917 has finished.

@pavelrappo
Copy link
Member Author

/integrate

@openjdk openjdk bot closed this Sep 14, 2020
@openjdk openjdk bot added integrated Pull request has been integrated and removed ready Pull request is ready to be integrated labels Sep 14, 2020
@openjdk
Copy link

openjdk bot commented Sep 14, 2020

@pavelrappo Since your change was applied there have been 57 commits pushed to the master branch:

  • 68da63d: 8240658: Code completion not working for lambdas in method invocations that require type inference
  • b05290a: 8252898: remove bulk registration of JFR CompilerPhaseType names
  • 779d2c3: 8253084: Zero VM is broken after JDK-8252689
  • 07da3a1: 8253030: ZGC: Change ZMarkCompleteTimeout unit to microseconds
  • f978f6f: 8252689: Classes are loaded from jrt:/java.base even when CDS is used
  • c5e63b6: 8248186: Move CDS C++ vtable code to cppVtables.cpp
  • 03a4df0: 8244778: Archive full module graph in CDS
  • 998ce78: 8252543: [JVMCI] Libgraal can deadlock in blocking compilation mode
  • b1b0f0b: 8253066: typo in Stream.mapMulti
  • 306b166: 8253033: CheckUnhandledOops check fails in ThreadSnapshot::initialize…
  • ... and 47 more: https://git.openjdk.java.net/jdk/compare/8d6d43c33b0d4b757addafae12739e60e785e53f...master

Your commit was automatically rebased without conflicts.

Pushed as commit e6a493a.

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

@openjdk openjdk bot removed the rfr Pull request is ready for review label Sep 14, 2020
@pavelrappo pavelrappo deleted the 8252882 branch September 15, 2020 18:17
robehn pushed a commit to robehn/jdk that referenced this pull request Dec 11, 2023
pfirmstone added a commit to pfirmstone/jdk-with-authorization that referenced this pull request Nov 18, 2024
…5a69045d5b1cb3468f24ff6

[Snyk] Upgrade org.jboss.openjdk-orb:openjdk-orb from 8.1.4.Final to 8.1.9.Final
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
compiler compiler-dev@openjdk.org integrated Pull request has been integrated javadoc javadoc-dev@openjdk.org
Development

Successfully merging this pull request may close these issues.

2 participants