[llvm] [NFC] Reformat comment (PR #116003)

Serge Pavlov via llvm-commits llvm-commits at lists.llvm.org
Tue Nov 12 22:40:52 PST 2024


https://github.com/spavloff created https://github.com/llvm/llvm-project/pull/116003

None

>From 17a23060bb46dde77086a3513ebdc83009464e24 Mon Sep 17 00:00:00 2001
From: Serge Pavlov <sepavloff at gmail.com>
Date: Wed, 13 Nov 2024 13:36:42 +0700
Subject: [PATCH] [NFC] Reformat comment

---
 .../llvm/CodeGen/GlobalISel/CSEMIRBuilder.h    | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

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 {



More information about the llvm-commits mailing list