8267570: The comment of the class JavacParser is not appropriate

[lgxbslgx]

Hi all,

The following comment of the class JavacParser is not appropriate.

It operates by recursive descent, with code derived
systematically from an LL(1) grammar.

From the source code, the current javac parser looks like a LL(K) parser instead of LL(1).
This patch revises the comment so that developers won't be confused by it.

Thank you for taking the time to review.

Best Regards,
-- Guoxiong

---

Progress

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

Issue

• JDK-8267570: The comment of the class JavacParser is not appropriate

Reviewers

• Jonathan Gibbons (@jonathan-gibbons - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 4153

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

Using diff file

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

[bridgekeeper]

👋 Welcome back gli! 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]

@lgxbslgx The following label will be automatically applied to this pull request:

• compiler

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.

[mlbridge]

Webrevs

• 01: Full - Incremental (c5f012a8)
• 00: Full (afc12850)

[jonathan-gibbons]

In general, temporal words (like "current") should be avoided as a matter of style.

I suggest:

The parser is a hand-written recursive-descent parser that
implements the grammar described in the Java Language Specification.

[lgxbslgx]

Fixed.

[lgxbslgx]

@jonathan-gibbons I revised the comment according to your suggestion. Thanks for your re-review.

[openjdk]

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

8267570: The comment of the class JavacParser is not appropriate

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

• 37bc4e2: 8263635: Add --servername option to jhsdb debugd
• 6ffa3e6: 8267754: cds/appcds/loaderConstraints/LoaderConstraintsTest.java fails on x86_32 due to customized class loader is not supported
• 1899f02: 8267805: Add UseVtableBasedCHA to the list of JVM flags known to jtreg
• 0fc7c8d: 8267751: (test) jtreg.SkippedException has no serial VersionUID
• a859d87: 8267721: Enable sun/security/pkcs11 tests for Amazon Linux 2 AArch64
• e630235: 8266851: Implement JEP 403: Strongly Encapsulate JDK Internals
• 8c4719a: 8265248: Implementation Specific Properties: change prefix, plus add existing properties
• c59484e: 8267653: Remove Mutex::_safepoint_check_sometimes
• de91643: 8267611: Print more info when pointer_delta assert fails
• a4c46e1: 8263202: Update Hebrew/Indonesian/Yiddish ISO 639 language codes to current
• ... and 52 more: https://git.openjdk.java.net/jdk/compare/24623167ffbf8e192ef539fd0a969412719f850c...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.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@jonathan-gibbons) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

[lgxbslgx]

@jonathan-gibbons Thanks for your review. Could I get your help to sponsor this patch?

/integrate

[openjdk]

@lgxbslgx
Your change (at version c5f012a) is now ready to be sponsored by a Committer.

[vicente-romero-oracle]

/sponsor

[openjdk]

@vicente-romero-oracle @lgxbslgx Since your change was applied there have been 127 commits pushed to the master branch:

• 379376f: 8265130: Make ConstantDesc class hierarchy sealed
• 00c7aee: 8267861: Update SourceVersion with new language features in 16 and 17
• cb7128b: 8266950: Remove vestigial support for non-strict floating-point execution
• 8624cb5: 8266530: HotSpot changes for JEP 306
• 0ae4ceb: 8244146: javac changes for JEP 306
• c2c0208: 8267089: Use typedef KVHashtable for ID2KlassTable
• ccfcd92: 8180571: Refactor sun/security/pkcs11 shell tests to plain java tests and fix failures
• 40e4171: 8264800: cleanup Threads_lock comments in JVM/TI function headers
• b17b11e: 8267562: G1: Missing BOT in Open Archive regions causes long pauses
• 2b33835: 8265148: StackWatermarkSet being updated during AsyncGetCallTrace
• ... and 117 more: https://git.openjdk.java.net/jdk/compare/24623167ffbf8e192ef539fd0a969412719f850c...master

Your commit was automatically rebased without conflicts.

Pushed as commit b98e52a.

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