[commit: ghc] master: Document a Haddock/Mavericks bug. (943f22a)

[git at git.haskell.org]

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

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/943f22a4c959a2d0c0e47fc40c2163ef7760b6d9/ghc

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

commit 943f22a4c959a2d0c0e47fc40c2163ef7760b6d9
Author: Austin Seipp <austin at well-typed.com>
Date:   Tue Jan 28 08:17:50 2014 -0600

    Document a Haddock/Mavericks bug.
    
    Signed-off-by: Austin Seipp <austin at well-typed.com>


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

943f22a4c959a2d0c0e47fc40c2163ef7760b6d9
 docs/users_guide/7.8.1-notes.xml |   35 +++++++++++++++++++++++++++++++----
 1 file changed, 31 insertions(+), 4 deletions(-)

diff --git a/docs/users_guide/7.8.1-notes.xml b/docs/users_guide/7.8.1-notes.xml
index a4fe520..9686301 100644
--- a/docs/users_guide/7.8.1-notes.xml
+++ b/docs/users_guide/7.8.1-notes.xml
@@ -1178,12 +1178,39 @@
     <itemizedlist>
         <listitem>
             <para>
+                On OS X Mavericks, when using Clang as the C
+                preprocessor, Haddock has a bug that causes it to fail
+                to generate documentation, with an error similar to
+                the following:
+
+<programlisting>
+<no location info>:
+    module 'xhtml-3000.2.1:Main' is defined in multiple files: dist-bindist/build/tmp-72252/Text/XHtml.hs
+                                                               dist-bindist/build/tmp-72252/Text/XHtml/Frameset.hs
+                                                               dist-bindist/build/tmp-72252/Text/XHtml/Strict.hs
+                                                               dist-bindist/build/tmp-72252/Text/XHtml/Transitional.hs
+...
+</programlisting>
+
+           </para>
+            <para>
+                This only affects certain packages. This is due to a
+                bad interaction with Clang, which we hope to resolve
+                soon.
+           </para>
+            <para>
+                Note that when using <literal>cabal-install</literal>,
+                this only effects the package documentation, not
+                installation or building.
+           </para>
+       </listitem>
+        <listitem>
+            <para>
                 On OS X 10.7 and beyond, with default build settings,
                 the runtime system currently suffers from a fairly
-                large (30%) performance regression in the parallel
-                garbage collector when using
-                <literal>-threaded</literal> impacting its thoroughput
-                and overall scalability.
+                large (approx. 30%) performance regression in the
+                parallel garbage collector when using
+                <literal>-threaded</literal>.
            </para>
             <para>
                 This is due to the fact that the OS X 10.7+ toolchain