AArch64: add block comments where missing
authorTim Northover <Tim.Northover@arm.com>
Thu, 14 Feb 2013 16:17:01 +0000 (16:17 +0000)
committerTim Northover <Tim.Northover@arm.com>
Thu, 14 Feb 2013 16:17:01 +0000 (16:17 +0000)
Only comments affected. No code change at all.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@175169 91177308-0d34-0410-b5e6-96231b3b80d8

19 files changed:
lib/Target/AArch64/AArch64.td
lib/Target/AArch64/AArch64AsmPrinter.h
lib/Target/AArch64/AArch64FrameLowering.h
lib/Target/AArch64/AArch64InstrFormats.td
lib/Target/AArch64/AArch64InstrInfo.td
lib/Target/AArch64/AArch64MachineFunctionInfo.cpp
lib/Target/AArch64/AArch64RegisterInfo.h
lib/Target/AArch64/AArch64RegisterInfo.td
lib/Target/AArch64/AArch64TargetMachine.cpp
lib/Target/AArch64/AArch64TargetObjectFile.cpp
lib/Target/AArch64/AArch64TargetObjectFile.h
lib/Target/AArch64/AsmParser/AArch64AsmParser.cpp
lib/Target/AArch64/Disassembler/AArch64Disassembler.cpp
lib/Target/AArch64/MCTargetDesc/AArch64AsmBackend.cpp
lib/Target/AArch64/MCTargetDesc/AArch64ELFObjectWriter.cpp
lib/Target/AArch64/MCTargetDesc/AArch64FixupKinds.h
lib/Target/AArch64/MCTargetDesc/AArch64MCExpr.cpp
lib/Target/AArch64/MCTargetDesc/AArch64MCExpr.h
lib/Target/AArch64/TargetInfo/AArch64TargetInfo.cpp

index 0e4f5fb1c5f318d908a3282b6b3c79633370f18d..e17052b4a565bf5b8d2cdebb431baf26aa23556a 100644 (file)
@@ -6,7 +6,9 @@
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
+//
 // This is the top level entry point for the AArch64 target.
+//
 //===----------------------------------------------------------------------===//
 
 //===----------------------------------------------------------------------===//
index 492be66fbdb50e1d7eedca5738b7e6e7d0b18dd0..b6f9ee6ebef8fc71ccbd9c0d87c65348e02abfe1 100644 (file)
@@ -7,7 +7,7 @@
 //
 //===----------------------------------------------------------------------===//
 //
-// AArch64 Assembly printer class.
+// This file defines the AArch64 assembly printer class.
 //
 //===----------------------------------------------------------------------===//
 
index a14c2bb7912af531045bd3fb013a6078c55e84aa..bca7b06921cdeaef2aa8dbf83f3bfbe21d0dbf2e 100644 (file)
@@ -7,7 +7,8 @@
 //
 //===----------------------------------------------------------------------===//
 //
-//
+// This class implements the AArch64-specific parts of the TargetFrameLowering
+// class.
 //
 //===----------------------------------------------------------------------===//
 
index c6aa265638a425e630fa4eecc7dd18f5606cc57f..8cb770ea7f8f4c02defb103bfebec59d17f40a46 100644 (file)
@@ -6,11 +6,14 @@
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
+// This file describes AArch64 instruction formats, down to the level of the
+// instruction's overall class.
+// ===----------------------------------------------------------------------===//
+
 
 //===----------------------------------------------------------------------===//
-//
 // A64 Instruction Format Definitions.
-//
+//===----------------------------------------------------------------------===//
 
 // A64 is currently the only instruction set supported by the AArch64
 // architecture.
index adcab89e723fedccefa3eac1ba340f45e166560d..d514364e1b9293e8e522240e17f7aacc849b0b3f 100644 (file)
@@ -1,3 +1,16 @@
+//===----- AArch64InstrInfo.td - AArch64 Instruction Info ----*- tablegen -*-=//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// This file describes the AArch64 scalar instructions in TableGen format.
+//
+//===----------------------------------------------------------------------===//
+
 include "AArch64InstrFormats.td"
 
 //===----------------------------------------------------------------------===//
index 012a4f8a6812b3ef6bc81e65772c88b2d85aaa74..f45d8f784f4251dfc9f24537ee432ea49b6e1a91 100644 (file)
@@ -6,7 +6,11 @@
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
-
+//
+// This file just contains the anchor for the AArch64MachineFunctionInfo to
+// force vtable emission.
+//
+//===----------------------------------------------------------------------===//
 #include "AArch64MachineFunctionInfo.h"
 
 using namespace llvm;
index 3be083d5f6b17ab5c3a569d1f9ae644142c721da..a25f9d2bdc43e969f51d789a4a89854a1e500da2 100644 (file)
@@ -7,7 +7,7 @@
 //
 //===----------------------------------------------------------------------===//
 //
-// This file contains the AArch64 implementation of the MRegisterInfo class.
+// This file contains the AArch64 implementation of the MCRegisterInfo class.
 //
 //===----------------------------------------------------------------------===//
 
index 3cbbf1405cb5a5790f98b623f2bc40c39cf36286..bd79546371c5c6296ce376bce0916d37c9433d7e 100644 (file)
@@ -1,4 +1,4 @@
-//===- ARMRegisterInfo.td - ARM Register defs --------------*- tablegen -*-===//
+//===- AArch64RegisterInfo.td - ARM Register defs ----------*- tablegen -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
@@ -6,9 +6,9 @@
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
-
-//===----------------------------------------------------------------------===//
-//  Declarations that describe the ARM register file
+//
+//  This file contains declarations that describe the AArch64 register file
+//
 //===----------------------------------------------------------------------===//
 
 let Namespace = "AArch64" in {
index 68e3643d8edb3c0ca814ac63601307f364c89fbc..5a18338d2a0d4fa3e79656f931c6034bf58d0fcf 100644 (file)
@@ -7,6 +7,9 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file contains the implementation of the AArch64TargetMachine
+// methods. Principally just setting up the passes needed to generate correct
+// code on this architecture.
 //
 //===----------------------------------------------------------------------===//
 
index d5c3e89c956d3a900142eabc6d1f8c2f866d9f72..b4452f5145909002c7d79cfd278f84da346bbd22 100644 (file)
@@ -6,6 +6,11 @@
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
+//
+// This file deals with any AArch64 specific requirements on object files.
+//
+//===----------------------------------------------------------------------===//
+
 
 #include "AArch64TargetObjectFile.h"
 
index 07caac1d93fa2fc90b81563b5d4d2776cace7c40..bf0565a79ec879e3783dcca8645979bbcceaeac7 100644 (file)
@@ -6,6 +6,10 @@
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
+//
+// This file deals with any AArch64 specific requirements on object files.
+//
+//===----------------------------------------------------------------------===//
 
 #ifndef LLVM_TARGET_AARCH64_TARGETOBJECTFILE_H
 #define LLVM_TARGET_AARCH64_TARGETOBJECTFILE_H
index 1cdeafb4dc29b85f156d6c48c734ada2713f2c0a..f871ecf67e93c1d9e36ac63dd4348b1aa8dd5891 100644 (file)
@@ -6,6 +6,11 @@
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
+//
+// This file contains the (GNU-style) assembly parser for the AArch64
+// architecture.
+//
+//===----------------------------------------------------------------------===//
 
 
 #include "MCTargetDesc/AArch64MCTargetDesc.h"
index 38d0e8eddefd1f5bf057df88bac6e65ddc874582..eba76667e2b874d42befe788d8d69c812c123368 100644 (file)
@@ -1,4 +1,4 @@
-//===- AArch64Disassembler.cpp - Disassembler for AArch64/Thumb ISA -------===//
+//===- AArch64Disassembler.cpp - Disassembler for AArch64 ISA -------------===//
 //
 //                     The LLVM Compiler Infrastructure
 //
@@ -6,6 +6,12 @@
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
+//
+// This file contains the functions necessary to decode AArch64 instruction
+// bitpatterns into MCInsts (with the help of TableGenerated information from
+// the instruction definitions).
+//
+//===----------------------------------------------------------------------===//
 
 #define DEBUG_TYPE "arm-disassembler"
 
index 5d5e38e6f7fe54bc078a23200ef6ee28bc7435df..a3373b1087bb016a20670f1cfc6d4d3598b3e505 100644 (file)
@@ -6,6 +6,11 @@
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
+//
+// This file contains the AArch64 implementation of the MCAsmBackend class,
+// which is principally concerned with relaxation of the various fixup kinds.
+//
+//===----------------------------------------------------------------------===//
 
 #include "MCTargetDesc/AArch64FixupKinds.h"
 #include "MCTargetDesc/AArch64MCTargetDesc.h"
index 476b94e70fe5a673ffcf40315938302c37e25a6b..4bcc65dfca27dce22094718c24c03d060addc834 100644 (file)
@@ -6,6 +6,11 @@
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
+//
+// This file handles ELF-specific object emission, converting LLVM's internal
+// fixups into the appropriate relocations.
+//
+//===----------------------------------------------------------------------===//
 
 #include "MCTargetDesc/AArch64FixupKinds.h"
 #include "MCTargetDesc/AArch64MCTargetDesc.h"
index 15e088667cba4a078f52a2f08cb558e737e35880..eeb122d38494644b561bc2aef84412b264f62dea 100644 (file)
@@ -6,6 +6,11 @@
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
+//
+// This file describes the LLVM fixups applied to MCInsts in the AArch64
+// backend.
+//
+//===----------------------------------------------------------------------===//
 
 #ifndef LLVM_AARCH64_AARCH64FIXUPKINDS_H
 #define LLVM_AARCH64_AARCH64FIXUPKINDS_H
index e86e04aa33fb0f0ad9ecfb731820af4e5992066c..c1abfe74dfdd6009849fc2c0f8e27e50ba21682b 100644 (file)
@@ -6,6 +6,11 @@
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
+//
+// This file contains the implementation of the assembly expression modifiers
+// accepted by the AArch64 architecture (e.g. ":lo12:", ":gottprel_g1:", ...).
+//
+//===----------------------------------------------------------------------===//
 
 #define DEBUG_TYPE "aarch64mcexpr"
 #include "AArch64MCExpr.h"
index f2af2049b6bad71cc04d1a472453fa661ea19d73..c0e3b29474d1f5565f618c640b72ab47d4f6a397 100644 (file)
@@ -6,6 +6,11 @@
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
+//
+// This file describes AArch64-specific MCExprs, used for modifiers like
+// ":lo12:" or ":gottprel_g1:".
+//
+//===----------------------------------------------------------------------===//
 
 #ifndef LLVM_AARCH64MCEXPR_H
 #define LLVM_AARCH64MCEXPR_H
index 5dbdc57d0e60c806bbc0344417e06dcbf025d9bc..b8099cb26b0f78da1d332953f95e423215593439 100644 (file)
@@ -6,6 +6,10 @@
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
+//
+// This file contains the key registration step for the architecture.
+//
+//===----------------------------------------------------------------------===//
 
 #include "AArch64.h"
 #include "llvm/IR/Module.h"