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

Updating README to refer to ANTLR 5 #9

Merged
merged 4 commits into from
Feb 1, 2024

Conversation

ftomassetti
Copy link
Collaborator

@ftomassetti ftomassetti commented Jan 25, 2024

I took a first look at the README, renaming most references to ANTLR 4 into references to ANTLR 5.

I also tried to:

  • State that this project is experimental, and that most people should look at ANTLR 4
  • Summarizing very shortly why ANTLR 5 came to by and pointing out to antlr5-specs for the details
  • Remove some links that were very specific to ANTLR 4
  • Add a comment about The Definitive ANTLR 4 Reference, in the context of ANTLR 5
  • Add a reference to grammars-v5 (while keeping a reference to grammars-v4)

This is related to #3

Follow up: Update image to change master into main. This would be easier if we had the sources of the image.

@ericvergnaud
Copy link
Contributor

ericvergnaud commented Jan 25, 2024

Thanks! I'm fine with the proposed changes, but @KvanTTT has asked to put on hold any PR until he completes #6 so I'll merge once done.

@ftomassetti
Copy link
Collaborator Author

Makes sense, thank you Eric!

@sschuberth
Copy link

put on hold any PR until he completes #6 so I'll merge once done.

That PR doesn't touch the README.md, though... yet.

@ericvergnaud
Copy link
Contributor

Sure but he might need to rebase to an old commit, in which case we'd have to redo all this...
Let's be patient, it looks like we're not very far...

README.md Outdated
As of now, there is no collection of grammars for ANTLR 5, but we plan
to grow such collection in [grammars-v5](https://github.com/antlr/grammars-v5), which is currently empty.

Until we get grammars for ANTLR 5, you can take a look at [this repository](https://github.com/antlr/grammars-v4); it is a collection of grammars for ANTLR 4 without actions where the
Copy link
Collaborator

Choose a reason for hiding this comment

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

The phrase "without actions" has bothered me for a while. I don't think it is correct.

First, there are many grammars in grammars-v4 that contain both "actions" and "semantic predicates". According to the documentation:

In either case, we have a slew.

  • "actions", using Trash, //actionBlock[not(following-sibling::QUESTION)].
    actions.txt

  • "semantic predicates", using Trash, //actionBlock[following-sibling::QUESTION].
    sem-preds.txt

Secondly, they are lexed identically, and parsed nearly identically.

The phrase should be deleted.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thank you, I will remove the sentence

@KvanTTT
Copy link
Member

KvanTTT commented Jan 28, 2024

@ftomassetti please rebase on dev and remove duplicated commit (78a857c).

@KvanTTT
Copy link
Member

KvanTTT commented Jan 28, 2024

That PR doesn't touch the README.md, though... yet.

Yes, but I want to keep git history as clear as possible. Maybe it's out of priority for other contributors but it's important for me (I've been working on Kotlin Compiler for almost 3 years and I understand how it could be important). That's why I adhere Rebase and merge or Squash and merge merging methods that don't produce extra merging commits.

And I didn't want to have extra commits in dev before #6 merging (I can't interactively rebase that branch because it is non-standard since it contains merge from unrelated histories). Yes, I could use commits cherry-picking, but it was better to wait until merging.

Now the merge is finished (force-push to dev) and other PRs can be merged using safe GitHub methods.

@ftomassetti
Copy link
Collaborator Author

I know I need to re-sign the commits, but I am currently at a computer where I need to reconfigure GPG, so I will do that as soon as I can

@ftomassetti ftomassetti force-pushed the readme-v5 branch 2 times, most recently from dc7abfb to 8473b2d Compare January 29, 2024 07:28
@ftomassetti
Copy link
Collaborator Author

Ok, it seems now that DCO and tests are all green

@ericvergnaud
Copy link
Contributor

I suggest you rebase, I had some changes on my side not yet merged.

Signed-off-by: Federico Tomassetti <[email protected]>
Signed-off-by: Federico Tomassetti <[email protected]>
Signed-off-by: Federico Tomassetti <[email protected]>
Signed-off-by: Federico Tomassetti <[email protected]>
@ftomassetti
Copy link
Collaborator Author

Sure, I have now rebased

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@ftomassetti
Copy link
Collaborator Author

Thank you for approving the PR!
I think I cannot merge this myself, so would you merge it?
I see there is also a check failing (regarding the kotlin runtime but only on macos). However, given I just touched the README, I think we can safely consider it unrelated to the PR

@ericvergnaud ericvergnaud merged commit 14eb2aa into antlr:dev Feb 1, 2024
9 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants