From: Daniel Vetter <daniel.vetter@ffwll.ch>
Date: Sun, 23 Mar 2014 14:14:16 +0000 (+0100)
Subject: lib/intel_batchbuffer: document header dependencies
X-Git-Tag: intel-gpu-tools-1.7~213
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=816c94723632b4876b3b0b965009ceab5e8bec2b;p=platform%2Fupstream%2Fintel-gpu-tools.git

lib/intel_batchbuffer: document header dependencies

At least with the core library headers the situation is now fairly
sane. There's still fun stuff going on around *_reg.h and most of the
source files just have a cargo-culted list of headers ...

Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
---

diff --git a/lib/intel_batchbuffer.c b/lib/intel_batchbuffer.c
index 3292394..0d583c7 100644
--- a/lib/intel_batchbuffer.c
+++ b/lib/intel_batchbuffer.c
@@ -56,6 +56,9 @@
  * batchbuffers. All those macros presume that a pointer to a #intel_batchbuffer
  * structure called batch is in scope. The basic macros are #BEGIN_BATCH,
  * #OUT_BATCH, #OUT_RELOC and #ADVANCE_BATCH.
+ *
+ * Note that this library's header pulls in the [i-g-t core](intel-gpu-tools-i-g-t-core.html)
+ * library as a depency.
  */
 
 /**