Merge pull request #1070 from phadej/hyperlinked-source

Use --hyperlinked-source if available
commercialhaskell · Sep 29, 2015 · f04c9d0 · f04c9d0
2 parents 9c60d92 + d07b7be
commit f04c9d0
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 5 deletions.
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -21,6 +21,7 @@ Other enhancements:
   can still get this behavior by running the following yourself:
   `stack exec -- pacman -Sy --noconfirm git`.
 * Typing enter during --file-watch triggers a rebuild [#1023](https://github.com/commercialhaskell/stack/pull/1023)
+* Use Haddock's `--hyperlinked-source` (crosslinked source), if available [#1070](https://github.com/commercialhaskell/stack/pull/1070)
 
 Bug fixes:
 

diff --git a/src/Stack/Build/Execute.hs b/src/Stack/Build/Execute.hs
@@ -974,12 +974,21 @@ singleBuild runInBase ac@ActionContext {..} ee@ExecuteEnv {..} task@Task {..} in
 
         when (doHaddock package) $ do
             announce "haddock"
-            hscolourExists <- doesExecutableExist eeEnvOverride "HsColour"
-            unless hscolourExists $ $logWarn
-                ("Warning: haddock not generating hyperlinked sources because 'HsColour' not\n" <>
-                 "found on PATH (use 'stack install hscolour' to install).")
+            sourceFlag <- do
+                hyped <- tryProcessStdout Nothing eeEnvOverride "haddock" ["--hyperlinked-source"]
+                case hyped of
+                    -- Fancy crosslinked source
+                    Right _ -> do
+                        return ["--haddock-option=--hyperlinked-source"]
+                    -- Older hscolour colouring
+                    Left _  -> do
+                        hscolourExists <- doesExecutableExist eeEnvOverride "HsColour"
+                        unless hscolourExists $ $logWarn
+                            ("Warning: haddock not generating hyperlinked sources because 'HsColour' not\n" <>
+                             "found on PATH (use 'stack install hscolour' to install).")
+                        return ["--hyperlink-source" | hscolourExists]
             cabal False (concat [["haddock", "--html", "--hoogle", "--html-location=../$pkg-$version/"]
-                                ,["--hyperlink-source" | hscolourExists]
+                                ,sourceFlag
                                 ,["--ghcjs" | wc == Ghcjs]])
 
         withMVar eeInstallLock $ \() -> do