Skip to content

[NFC] add explanation to register flags doc #91803

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

Conversation

fmayer
Copy link
Contributor

@fmayer fmayer commented May 10, 2024

No description provided.

fmayer added 2 commits May 10, 2024 13:27
Created using spr 1.3.4
Created using spr 1.3.4
@fmayer fmayer requested review from jmorse and nikic May 10, 2024 20:33
@nikic nikic requested review from arsenm and removed request for nikic May 14, 2024 00:44
Copy link
Contributor

@arsenm arsenm left a comment

Choose a reason for hiding this comment

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

Most of these could use more elaboration, especially earlyclobber and renamable


* - ``early-clobber``
- ``RegState::EarlyClobber``
- Register definition happens before uses.
Copy link
Contributor

Choose a reason for hiding this comment

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

This one probably needs more elaboration


* - ``renamable``
- ``RegState::Renamable``
- Register that may be renamed.
Copy link
Contributor

Choose a reason for hiding this comment

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

Also probably needs more explanation

@fmayer
Copy link
Contributor Author

fmayer commented May 14, 2024

Most of these could use more elaboration, especially earlyclobber and renamable

These are just copy pasted from the enum value comments

@arsenm
Copy link
Contributor

arsenm commented May 14, 2024

Most of these could use more elaboration, especially earlyclobber and renamable

These are just copy pasted from the enum value comments

Where I usually go to refer to them, and still don't understand what renamable actually does

@@ -540,6 +540,9 @@ Register Flags
The table below shows all of the possible register flags along with the
corresponding internal ``llvm::RegState`` representation:

..
Keep this in sync with MachineInstrBuilder.h
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this appear in the generated output?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@fmayer fmayer merged commit 80f8ae3 into main May 14, 2024
4 of 5 checks passed
@fmayer fmayer deleted the users/fmayer/spr/nfc-add-explanation-to-register-flags-doc branch May 14, 2024 18:34
fmayer added a commit to fmayer/llvm-project that referenced this pull request Sep 13, 2024
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.

2 participants