From: Zack Rusin <zack@tungstengraphics.com>
Date: Thu, 13 Mar 2008 02:06:51 +0000 (-0400)
Subject: Add some basic documentation for gallivm code
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=2366bb1baf2e9ae5b6ecf19f66ae9e0a4b0d2f36;p=mesa.git

Add some basic documentation for gallivm code
---

diff --git a/src/gallium/auxiliary/gallivm/gallivm.h b/src/gallium/auxiliary/gallivm/gallivm.h
index 57912a952fb..b4d6555d2fc 100644
--- a/src/gallium/auxiliary/gallivm/gallivm.h
+++ b/src/gallium/auxiliary/gallivm/gallivm.h
@@ -33,6 +33,16 @@
 #ifndef GALLIVM_H
 #define GALLIVM_H
 
+/*
+  LLVM representation consists of two stages - layout independent
+  intermediate representation gallivm_ir and driver specific
+  gallivm_prog. TGSI is first being translated into gallivm_ir
+  after that driver can set number of options on gallivm_ir and
+  have it compiled into gallivm_prog. gallivm_prog can be either
+  executed (assuming there's LLVM JIT backend for the current
+  target) or machine code generation can be done (assuming there's
+  a LLVM code generator for thecurrent target)
+ */
 #if defined __cplusplus
 extern "C" {
 #endif