Skip to content

[NFC] Reformat comment #116003

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
Nov 14, 2024
Merged

[NFC] Reformat comment #116003

merged 1 commit into from
Nov 14, 2024

Conversation

spavloff
Copy link
Collaborator

No description provided.

@spavloff spavloff requested a review from aemerson November 13, 2024 06:40
@spavloff spavloff self-assigned this Nov 13, 2024
@llvmbot
Copy link
Member

llvmbot commented Nov 13, 2024

@llvm/pr-subscribers-llvm-globalisel

Author: Serge Pavlov (spavloff)

Changes

Full diff: https://github.com/llvm/llvm-project/pull/116003.diff

1 Files Affected:

  • (modified) llvm/include/llvm/CodeGen/GlobalISel/CSEMIRBuilder.h (+12-6)
diff --git a/llvm/include/llvm/CodeGen/GlobalISel/CSEMIRBuilder.h b/llvm/include/llvm/CodeGen/GlobalISel/CSEMIRBuilder.h
index 488df12f13f8df..c8982af254217a 100644
--- a/llvm/include/llvm/CodeGen/GlobalISel/CSEMIRBuilder.h
+++ b/llvm/include/llvm/CodeGen/GlobalISel/CSEMIRBuilder.h
@@ -20,13 +20,19 @@ class GISelInstProfileBuilder;
 /// Defines a builder that does CSE of MachineInstructions using GISelCSEInfo.
 /// Eg usage.
 ///
+/// \code
+///    GISelCSEInfo *Info =
+///        &getAnalysis<GISelCSEAnalysisWrapperPass>().getCSEInfo();
+///    CSEMIRBuilder CB(Builder.getState());
+///    CB.setCSEInfo(Info);
+///    auto A = CB.buildConstant(s32, 42);
+///    auto B = CB.buildConstant(s32, 42);
+///    assert(A == B);
+///    unsigned CReg = MRI.createGenericVirtualRegister(s32);
+///    auto C = CB.buildConstant(CReg, 42);
+///    assert(C->getOpcode() == TargetOpcode::COPY);
+/// \endcode
 ///
-/// GISelCSEInfo *Info =
-/// &getAnalysis<GISelCSEAnalysisWrapperPass>().getCSEInfo(); CSEMIRBuilder
-/// CB(Builder.getState()); CB.setCSEInfo(Info); auto A = CB.buildConstant(s32,
-/// 42); auto B = CB.buildConstant(s32, 42); assert(A == B); unsigned CReg =
-/// MRI.createGenericVirtualRegister(s32); auto C = CB.buildConstant(CReg, 42);
-/// assert(C->getOpcode() == TargetOpcode::COPY);
 /// Explicitly passing in a register would materialize a copy if possible.
 /// CSEMIRBuilder also does trivial constant folding for binary ops.
 class CSEMIRBuilder : public MachineIRBuilder {

@spavloff spavloff merged commit 0341da5 into llvm:main Nov 14, 2024
10 checks passed
@spavloff spavloff deleted the reformat.comment branch November 14, 2024 05:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants