[llvm] r210189 - Support: add additional comment for ARM EH structure

[Saleem Abdulrasool]

Author: compnerd
Date: Wed Jun  4 10:47:04 2014
New Revision: 210189

URL: http://llvm.org/viewvc/llvm-project?rev=210189&view=rev
Log:
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.

Modified:
    llvm/trunk/include/llvm/Support/ARMWinEH.h

Modified: llvm/trunk/include/llvm/Support/ARMWinEH.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Support/ARMWinEH.h?rev=210189&r1=210188&r2=210189&view=diff
==============================================================================
--- llvm/trunk/include/llvm/Support/ARMWinEH.h (original)
+++ llvm/trunk/include/llvm/Support/ARMWinEH.h Wed Jun  4 10:47:04 2014
@@ -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;