[commit: haddock] master: Add documentation for --source-entity-line (b999504)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/haddock

On branch  : master
Link       : http://git.haskell.org/haddock.git/commitdiff/b9995041b5c838d41ba14ff684d9f5bfacd9ffc4

>---------------------------------------------------------------

commit b9995041b5c838d41ba14ff684d9f5bfacd9ffc4
Author: Niklas Haas <git at nand.wakku.to>
Date:   Tue Mar 11 09:11:21 2014 +0100

    Add documentation for --source-entity-line


>---------------------------------------------------------------

b9995041b5c838d41ba14ff684d9f5bfacd9ffc4
 doc/haddock.xml |    7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/haddock.xml b/doc/haddock.xml
index 5bc27ac..da0c545 100644
--- a/doc/haddock.xml
+++ b/doc/haddock.xml
@@ -539,6 +539,10 @@ $ pdflatex <replaceable>package</replaceable>.tex</screen>
 	  <indexterm><primary><option>--source-entity</option></primary></indexterm>
           <option>--source-entity</option>=<replaceable>URL</replaceable>
         </term>
+        <term>
+	  <indexterm><primary><option>--source-entity-line</option></primary></indexterm>
+	  <option>--source-entity-line</option>=<replaceable>URL</replaceable>
+        </term>
 	<listitem>
 	  <para>Include links to the source files in the generated
 	  documentation. Use the <option>--source-base</option> option to add a
@@ -547,6 +551,9 @@ $ pdflatex <replaceable>package</replaceable>.tex</screen>
 	  the header bar of each module page. Use the
 	  <option>--source-entity</option> option to add a source code link
 	  next to the documentation for every value and type in each module.
+	  <option>--source-entity-line</option> is a flag that gets used for
+	  entities that need to link to an exact source location rather than a
+	  name, eg. since they were defined inside a Template Haskell splice.
 	  </para>
 
 	  <para>In each case <replaceable>URL</replaceable> is the base URL