From 911e3dab9ab48da39414d85567e7e0f1fa32bd69 Mon Sep 17 00:00:00 2001
From: David Waern <david.waern@gmail.com>
Date: Sat, 15 May 2010 17:16:53 +0000
Subject: Document --no-tmp-comp-dir

---
 doc/haddock.xml | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'doc/haddock.xml')

diff --git a/doc/haddock.xml b/doc/haddock.xml
index f84be244..bfa02155 100644
--- a/doc/haddock.xml
+++ b/doc/haddock.xml
@@ -805,6 +805,23 @@
 	</listitem>
       </varlistentry>
       
+      <varlistentry>
+        <term>
+          <indexterm><primary><option>--no-tmp-comp-dir</option></primary></indexterm>
+          <option>--no-tmp-comp-dir</option>
+        </term>
+	<listitem>
+          <para>If the input modules use Template Haskell, Haddock has to
+          perform compilation (using GHC).  This results in .o, .hi, and stub files that
+          are written to a temporary directory by default. When this flag is specified,
+          however, the files are written to the present directory (or another path if you
+          tell GHC, for example like this: <literal>--optghc=-odir --optghc=path</literal>).
+          Note that not only will files be written to this directory, GHC will also look for
+          already existing files there, and use them in order to skip compilation.
+          </para>
+	</listitem>
+      </varlistentry>
+
       <varlistentry>
         <term>
           <indexterm><primary><option>-w</option></primary></indexterm>
-- 
cgit v1.2.3