Add a declaration of environ global for Darwin

[oota-llvm.git] / docs / ExtendingLLVM.html

diff --git a/docs/ExtendingLLVM.html b/docs/ExtendingLLVM.html
index c6f27f094bd9332def59323d356844d9764fcaeb..2e8982b8a50d5473789e15780383fbbf4f854c2e 100644 (file)
--- a/docs/ExtendingLLVM.html
+++ b/docs/ExtendingLLVM.html
@@ -23,8 +23,8 @@
   </ol></li>
 </ol>
 
-<div class="doc_text">    
-  <p><b>Written by <a href="http://misha.brukman.net">Misha Brukman</a></b></p>
+<div class="doc_author">    
+  <p>Written by <a href="http://misha.brukman.net">Misha Brukman</a></p>
 </div>
 
 <!-- *********************************************************************** -->
@@ -90,7 +90,7 @@ function and then be turned into an instruction if warranted.</p>
 <li><tt>llvm/include/llvm/Intrinsics.h</tt>:
     add an enum in the <tt>llvm::Intrinsic</tt> namespace</li>
 
-<li><tt>llvm/lib/VMCore/IntrinsicLowering.cpp</tt>:
+<li><tt>llvm/lib/CodeGen/IntrinsicLowering.cpp</tt>:
     implement the lowering for this intrinsic</li>
 
 <li><tt>llvm/lib/VMCore/Verifier.cpp</tt>:
@@ -101,7 +101,7 @@ function and then be turned into an instruction if warranted.</p>
     that you added.</li>
 
 <li><tt>llvm/lib/Analysis/BasicAliasAnalysis.cpp</tt>: If the new intrinsic does
-    not access memory, or does not write to memory, add it to the relevant list
+    not access memory or does not write to memory, add it to the relevant list
     of functions.</li>
 
 <li><tt>llvm/lib/Transforms/Utils/Local.cpp</tt>: If it is possible to constant
@@ -135,7 +135,7 @@ necessary.</p>
 <li><tt>llvm/include/llvm/Instruction.def</tt>:
     add a number for your instruction and an enum name</li>
 
-<li><tt>llvm/include/llvm/i*.h</tt>:
+<li><tt>llvm/include/llvm/Instructions.h</tt>:
     add a definition for the class that will represent your instruction</li>
 
 <li><tt>llvm/include/llvm/Support/InstVisitor.h</tt>:
@@ -154,8 +154,8 @@ necessary.</p>
 <li><tt>llvm/lib/VMCore/Instruction.cpp</tt>:
     add a case for how your instruction will be printed out to assembly</li>
 
-<li><tt>llvm/lib/VMCore/i*.cpp</tt>:
-    implement the class you defined in <tt>llvm/include/llvm/i*.h</tt></li>
+<li><tt>llvm/lib/VMCore/Instructions.cpp</tt>:
+    implement the class you defined in <tt>llvm/include/llvm/Instructions.h</tt></li>
 
 </ol>
 
@@ -215,7 +215,56 @@ installations.</span> Only add new types if it is absolutely necessary.</p>
 
 <div class="doc_text">
 
-<p>TODO</p>
+<ol>
+<li><tt>llvm/include/llvm/Type.def</tt>:
+    add enum for the type</li>
+
+<li><tt>llvm/include/llvm/Type.h</tt>:
+    add ID number for the new type; add a forward declaration of the type
+    also</li>
+
+<li><tt>llvm/include/llvm/DerivedType.h</tt>:
+    add new class to represent new class in the hierarchy; add forward 
+    declaration to the TypeMap value type</li>
+
+<li><tt>llvm/lib/VMCore/Type.cpp</tt>:
+    add support for derived type to: 
+<div class="doc_code">
+<pre>
+std::string getTypeDescription(const Type &amp;Ty,
+  std::vector&lt;const Type*&gt; &amp;TypeStack)
+bool TypesEqual(const Type *Ty, const Type *Ty2,
+  std::map&lt;const Type*, const Type*&gt; &amp; EqTypes)
+</pre>
+</div>
+    add necessary member functions for type, and factory methods</li>
+
+<li><tt>llvm/lib/AsmReader/Lexer.l</tt>:
+    add ability to parse in the type from text assembly</li>
+
+<li><tt>llvm/lib/ByteCode/Writer/Writer.cpp</tt>:
+    modify <tt>void BytecodeWriter::outputType(const Type *T)</tt> to serialize
+    your type</li>
+
+<li><tt>llvm/lib/ByteCode/Reader/Reader.cpp</tt>:
+    modify <tt>const Type *BytecodeReader::ParseType()</tt> to read your data
+    type</li> 
+
+<li><tt>llvm/lib/VMCore/AsmWriter.cpp</tt>:
+    modify
+<div class="doc_code">
+<pre>
+void calcTypeName(const Type *Ty,
+                  std::vector&lt;const Type*&gt; &amp;TypeStack,
+                  std::map&lt;const Type*,std::string&gt; &amp;TypeNames,
+                  std::string &amp; Result)
+</pre>
+</div>
+    to output the new derived type
+</li>  
+ 
+
+</ol>
 
 </div>