Minor cleanup. No functional changes intended.

[oota-llvm.git] / docs / WritingAnLLVMBackend.html
diff --git a/docs/WritingAnLLVMBackend.html b/docs/WritingAnLLVMBackend.html

index a1dc34c75b07434c829250e92ca8e3bf5b555b92..29dc1127c576f0a4c8e697069ceefd7cf8454cd4 100644 (file)
--- a/docs/WritingAnLLVMBackend.html
+++ b/docs/WritingAnLLVMBackend.html
@@ -2,6 +2,7 @@
                        "http://www.w3.org/TR/html4/strict.dtd">
  <html>
  <head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>Writing an LLVM Compiler Backend</title>
    <link rel="stylesheet" href="llvm.css" type="text/css">
  </head>
@@ -21,6 +22,7 @@
      <li><a href="#Preliminaries">Preliminaries</a></li>
    </ul>
    <li><a href="#TargetMachine">Target Machine</a></li>
+  <li><a href="#TargetRegistration">Target Registration</a></li>
    <li><a href="#RegisterSet">Register Set and Register Classes</a>
    <ul>
      <li><a href="#RegisterDef">Defining a Register</a></li>
@@ -421,21 +423,62 @@ SparcTargetMachine::SparcTargetMachine(const Module &amp;M, const std::string &a
      alignment, and then ABI preferred alignment.</li>
  </ul>
  
+</div>
+
+<!-- *********************************************************************** -->
+<div class="doc_section">
+  <a name="TargetRegistration">Target Registration</a>
+</div>
+<!-- *********************************************************************** -->
+
+<div class="doc_text">
+
+<p>
+You must also register your target with the <tt>TargetRegistry</tt>, which is
+what other LLVM tools use to be able to lookup and use your target at
+runtime. The <tt>TargetRegistry</tt> can be used directly, but for most targets
+there are helper templates which should take care of the work for you.</p>
+
+<p>
+All targets should declare a global <tt>Target</tt> object which is used to
+represent the target during registration. Then, in the target's TargetInfo
+library, the target should define that object and use
+the <tt>RegisterTarget</tt> template to register the target. For example, the Sparc registration code looks like this:
+</p>
+
+<div class="doc_code">
+<pre>
+Target llvm::TheSparcTarget;
+
+extern "C" void LLVMInitializeSparcTargetInfo() { 
+  RegisterTarget<Triple::sparc, /*HasJIT=*/false> 
+    X(TheSparcTarget, "sparc", "Sparc");
+}
+</pre>
+</div>
+
  <p>
-You must also register your target using the <tt>RegisterTarget</tt>
-template. (See the <tt>TargetMachineRegistry</tt> class.) For example,
-in <tt>SparcTargetMachine.cpp</tt>, the target is registered with:
+This allows the <tt>TargetRegistry</tt> to look up the target by name or by
+target triple. In addition, most targets will also register additional features
+which are available in separate libraries. These registration steps are
+separate, because some clients may wish to only link in some parts of the target
+-- the JIT code generator does not require the use of the assembler printer, for
+example. Here is an example of registering the Sparc assembly printer:
  </p>
  
  <div class="doc_code">
  <pre>
-namespace {
-  // Register the target.
-  RegisterTarget&lt;SparcTargetMachine&gt;X("sparc", "SPARC");
+extern "C" void LLVMInitializeSparcAsmPrinter() { 
+  RegisterAsmPrinter<SparcAsmPrinter> X(TheSparcTarget);
  }
  </pre>
  </div>
  
+<p>
+For more information, see
+"<a href="/doxygen/TargetRegistry_8h-source.html">llvm/Target/TargetRegistry.h</a>".
+</p>
+
  </div>
  
  <!-- *********************************************************************** -->
@@ -2037,8 +2080,8 @@ SparcTargetAsmInfo::SparcTargetAsmInfo(const SparcTargetMachine &amp;TM) {
  
  <p>
  The X86 assembly printer implementation (<tt>X86TargetAsmInfo</tt>) is an
-example where the target specific <tt>TargetAsmInfo</tt> class uses overridden
-methods: <tt>ExpandInlineAsm</tt> and <tt>PreferredEHDataFormat</tt>.
+example where the target specific <tt>TargetAsmInfo</tt> class uses an 
+overridden methods: <tt>ExpandInlineAsm</tt>.
  </p>
  
  <p>
@@ -2259,6 +2302,8 @@ XXXSubtarget::XXXSubtarget(const Module &amp;M, const std::string &amp;FS) {
  </pre>
  </div>
  
+</div>
+
  <!-- *********************************************************************** -->
  <div class="doc_section">
    <a name="jitSupport">JIT Support</a>