[llvm-commits] CVS: llvm/include/llvm/Target/TargetFrameInfo.h

[Chris Lattner]

Changes in directory llvm/include/llvm/Target:

TargetFrameInfo.h updated: 1.11 -> 1.12

---
Log message:

Add documentation to the TargetFrameInfo class, contributed by Vladimir Prus


---
Diffs of the changes:  (+7 -0)

Index: llvm/include/llvm/Target/TargetFrameInfo.h
diff -u llvm/include/llvm/Target/TargetFrameInfo.h:1.11 llvm/include/llvm/Target/TargetFrameInfo.h:1.12
--- llvm/include/llvm/Target/TargetFrameInfo.h:1.11	Thu Mar 11 17:52:03 2004
+++ llvm/include/llvm/Target/TargetFrameInfo.h	Tue Jun  8 01:23:17 2004
@@ -18,6 +18,13 @@
 
 class MachineFunction;
 
+/// Information about stack frame layout on the target.  It holds the direction
+/// of stack growth, the known stack alignment on entry to each function, and
+/// the offset to the locals area.
+///
+/// The offset to the local area is the offset from the stack pointer on
+/// function entry to the first location where function data (local variables,
+/// spill locations) can be stored.
 struct TargetFrameInfo {
   enum StackDirection {
     StackGrowsUp,        // Adding to the stack increases the stack address