Apply suggestions from code review

Co-authored-by: Tobias Gysi <[email protected]>

Author: zyx-billy

mlir/include/mlir/Dialect/LLVMIR/LLVMAttrDefs.td

@@ -10,9 +10,9 @@
 #define LLVMIR_ATTRDEFS
 
 include "mlir/Dialect/LLVMIR/LLVMDialect.td"
+include "mlir/Dialect/LLVMIR/LLVMInterfaces.td"
 include "mlir/IR/AttrTypeBase.td"
 include "mlir/IR/CommonAttrConstraints.td"
-include "mlir/Dialect/LLVMIR/LLVMInterfaces.td"
 
 // All of the attributes will extend this class.
 class LLVM_Attr<string name, string attrMnemonic,
@@ -386,7 +386,7 @@ def LLVM_DICompositeTypeAttr : LLVM_Attr<"DICompositeType", "di_composite_type",
     /// Get a copy of this type attr but with the recursive ID set to `recId`.
     DIRecursiveTypeAttrInterface withRecId(DistinctAttr recId);
 
-    /// Build a rec-self instance using the provided recId.
+    /// Build a rec-self instance using the provided `recId`.
     static DIRecursiveTypeAttrInterface getRecSelf(DistinctAttr recId);
 
     /// @}

mlir/include/mlir/Dialect/LLVMIR/LLVMInterfaces.td

@@ -6,7 +6,7 @@
 //
 //===----------------------------------------------------------------------===//
 //
-// This file defines op, type, & attr interfaces for the LLVM dialect in MLIR.
+// This file defines interfaces for the LLVM dialect in MLIR.
 //
 //===----------------------------------------------------------------------===//
 
@@ -341,10 +341,10 @@ def LLVM_DIRecursiveTypeAttrInterface
         replaced with the closest parent attr of the same type with the same
         recId.
 
-    e.g. To represent a linked list struct:
+    For example, to represent a linked list struct:
 
       #rec_self = di_composite_type<recId = 0>
-      #ptr = di_derived_type<baseType: #struct_self, ...>
+      #ptr = di_derived_type<baseType: #rec_self, ...>
       #field = di_derived_type<name = "next", baseType: #ptr, ...>
       #rec = di_composite_type<recId = 0, name = "Node", elements: #field, ...>
       #var = di_local_variable<type = #rec, ...>

mlir/lib/Target/LLVMIR/DebugImporter.cpp

@@ -260,7 +260,6 @@ DINodeAttr DebugImporter::translate(llvm::DINode *node) {
         iter->second = recId;
       }
       unboundRecursiveSelfRefs.back().insert(recId);
-
       return cast<DINodeAttr>(recSelfCtor(recId));
     }
   }
@@ -393,7 +392,7 @@ DistinctAttr DebugImporter::getOrCreateDistinctID(llvm::DINode *node) {
   return id;
 }
 
-llvm::function_ref<DIRecursiveTypeAttrInterface(DistinctAttr)>
+function_ref<DIRecursiveTypeAttrInterface(DistinctAttr)>
 DebugImporter::getRecSelfConstructor(llvm::DINode *node) {
   using CtorType =
       llvm::function_ref<DIRecursiveTypeAttrInterface(DistinctAttr)>;

mlir/lib/Target/LLVMIR/DebugImporter.h

@@ -99,8 +99,8 @@ class DebugImporter {
 
   /// A stack that stores the metadata nodes that are being traversed. The stack
   /// is used to detect cyclic dependencies during the metadata translation.
-  /// Nodes are pushed with a null value. If it is ever seen twice, it is given
-  /// a DistinctAttr ID, indicating that it is a recursive node.
+  /// A node is pushed with a null value. If it is ever seen twice, it is given
+  /// a recursive id attribute, indicating that it is a recursive node.
   llvm::MapVector<llvm::DINode *, DistinctAttr> translationStack;
   /// All the unbound recursive self references in the translation stack.
   SmallVector<DenseSet<DistinctAttr>> unboundRecursiveSelfRefs;

mlir/lib/Target/LLVMIR/DebugTranslation.h

@@ -101,7 +101,7 @@ class DebugTranslation {
 
   /// Get a placeholder DICompositeType without recursing into the elements.
   llvm::DICompositeType *translateImplGetPlaceholder(DICompositeTypeAttr attr);
-  /// Fill out the DICompositeType placeholder by recursively translating the
+  /// Completes the DICompositeType `placeholder` by recursively translating the
   /// elements.
   void translateImplFillPlaceholder(DICompositeTypeAttr attr,
                                     llvm::DICompositeType *placeholder);