From: Saleem Abdulrasool <compnerd@compnerd.org>
Date: Wed, 4 Jun 2014 15:47:04 +0000 (+0000)
Subject: Support: add additional comment for ARM EH structure
X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=bf9290fb48a07ffbcb9e2c3b995db854e6216419;p=oota-llvm.git

Support: add additional comment for ARM EH structure

Replicate the fact that ARM::WinEH::RuntimeFunction purposefully does not merge
functions to accommodate raw data access use cases in tools such as readobj.
Pointed out by Renato during post-commit review.

No functional change.

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

diff --git a/include/llvm/Support/ARMWinEH.h b/include/llvm/Support/ARMWinEH.h
index 6289f4f4299..31efbdc4ed5 100644
--- a/include/llvm/Support/ARMWinEH.h
+++ b/include/llvm/Support/ARMWinEH.h
@@ -90,6 +90,14 @@ enum class ReturnType {
 ///     + r11 must NOT be included in the set of registers described by Reg
 ///   - IF Ret is 0:
 ///     + L flag must be set
+
+// NOTE: RuntimeFunction is meant to be a simple class that provides raw access
+// to all fields in the structure.  The accessor methods reflect the names of
+// the bitfields that they correspond to.  Although some obvious simplifications
+// are possible via merging of methods, it would prevent the use of this class
+// to fully inspect the contents of the data structure which is particularly
+// useful for scenarios such as llvm-readobj to aid in testing.
+
 class RuntimeFunction {
 public:
   const support::ulittle32_t BeginAddress;