Skip to content

[CIR][Doc][NFC] Add a description for all the passes #1282

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

Merged
merged 1 commit into from
Jan 13, 2025

Conversation

keryell
Copy link
Collaborator

@keryell keryell commented Jan 13, 2025

Some passes not declared with TableGen did not have descriptions.

Some passes not declared with TableGen did not have descriptions.
Copy link
Member

@bcardosolopes bcardosolopes left a comment

Choose a reason for hiding this comment

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

LGTM, some nit in the comment that can be addressed in follow up PRs, this is overall goodness already

@@ -1356,7 +1356,11 @@ struct ConvertCIRToLLVMPass

void processCIRAttrs(mlir::ModuleOp moduleOp);

virtual StringRef getArgument() const override { return "cir-flat-to-llvm"; }
StringRef getDescription() const override {
return "Convert the prepared CIR dialect module to LLVM dialect";
Copy link
Member

Choose a reason for hiding this comment

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

Can we get that for free by adding let description for these passes?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I do not think these passes are described in a TableGen file.
Do you mean we should define them in a TableGen file first and then add such a description there?

@bcardosolopes bcardosolopes merged commit ef20d05 into llvm:main Jan 13, 2025
7 checks passed
@keryell
Copy link
Collaborator Author

keryell commented Jan 14, 2025

LGTM, some nit in the comment that can be addressed in follow up PRs, this is overall goodness already

You should have done some suggestions! 😄

lanza pushed a commit that referenced this pull request Mar 18, 2025
Some passes not declared with TableGen did not have descriptions.
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.

3 participants