Fix #5210 Don't refer to index.html when Haddock will not create it

haskell · Oct 14, 2023 · de98817 · de98817
1 parent 9f37325
commit de98817
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/Cabal/src/Distribution/Simple/Haddock.hs b/Cabal/src/Distribution/Simple/Haddock.hs
@@ -821,14 +821,21 @@ renderArgs verbosity tmpFileOpts version comp platform args k = do
         else k (renderedArgs, result)
   where
     outputDir = (unDir $ argOutputDir args)
+    isNotArgContents = isNothing (flagToMaybe $ argContents args)
+    isNotArgIndex = isNothing (flagToMaybe $ argIndex args)
+    isArgGenIndex = fromFlagOrDefault False (argGenIndex args)
+    -- Haddock, when generating HTML, does not generate an index if the options
+    -- --use-contents or --use-index are passed to it. See
+    -- https://haskell-haddock.readthedocs.io/en/latest/invoking.html#cmdoption-use-contents
+    isIndexGenerated = isArgGenIndex && isNotArgContents && isNotArgIndex
     result =
       intercalate ", "
         . map
           ( \o ->
               outputDir
                 </> case o of
                   Html
-                    | fromFlagOrDefault False (argGenIndex args) ->
+                    | isIndexGenerated ->
                         "index.html"
                   Html
                     | otherwise ->

diff --git a/changelog.d/pr-9332 b/changelog.d/pr-9332
@@ -0,0 +1,4 @@
+synopsis: Don't report `index.html` file as created, if not created by Haddock
+packages: Cabal cabal-install
+prs: #9332
+issues: #5120