From: Rafael Espindola <rafael.espindola@gmail.com>
Date: Wed, 16 Oct 2013 14:54:39 +0000 (+0000)
Subject: Add more documentation about the TargetStreamer interface.
X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=a24cd7206d08372e453438222e33d1ebf7284579;p=oota-llvm.git

Add more documentation about the TargetStreamer interface.

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

diff --git a/docs/CodeGenerator.rst b/docs/CodeGenerator.rst
index 4b992888115..c87a6286727 100644
--- a/docs/CodeGenerator.rst
+++ b/docs/CodeGenerator.rst
@@ -643,6 +643,11 @@ inherit from it, a target object streamer and a target asm streamer. The target
 asm streamer just prints it (``emitFnStart -> .fnstrart``), and the object
 streamer implement the assembler logic for it.
 
+To make llvm use these classes, the target initialization must call
+TargetRegistry::RegisterAsmStreamer and TargetRegistry::RegisterMCObjectStreamer
+passing callbacks that allocate the corresponding target streamer and pass it
+to createAsmStreamer or to the appropriate object streamer constructor.
+
 The ``MCContext`` class
 -----------------------