Merge pull request #9332 from haskell/fix5210

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

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 ->

cabal-testsuite/PackageTests/NewHaddock/HaddockOutput/HaddockForHackageCmdOutput/A/A.cabal

@@ -0,0 +1,10 @@
+cabal-version: 3.6
+name:          A
+synopsis:      A minimal test package for testing haddock.
+version:       0.0.0
+
+library
+  build-depends:    base
+  default-language: Haskell2010
+  exposed-modules:  A
+  hs-source-dirs:   .

cabal-testsuite/PackageTests/NewHaddock/HaddockOutput/HaddockForHackageCmdOutput/A/A.hs

@@ -0,0 +1,6 @@
+-- | A minimal test module for testing haddock.
+module A (a) where
+
+-- | a is zero.
+a :: Int
+a = 0

cabal-testsuite/PackageTests/NewHaddock/HaddockOutput/HaddockForHackageCmdOutput/cabal.out

@@ -0,0 +1,10 @@
+# cabal haddock
+Resolving dependencies...
+Build profile: -w ghc-<GHCVER> -O1
+In order, the following will be built:
+ - A-0.0.0 (lib) (first run)
+Configuring library for A-0.0.0...
+Preprocessing library for A-0.0.0...
+Running Haddock on library for A-0.0.0...
+Documentation created: <ROOT>/cabal.dist/work/dist/build/<ARCH>/ghc-<GHCVER>/A-0.0.0/doc/html/A-0.0.0-docs/, <ROOT>/cabal.dist/work/dist/build/<ARCH>/ghc-<GHCVER>/A-0.0.0/doc/html/A-0.0.0-docs/A.txt
+Documentation tarball created: <ROOT>/cabal.dist/work/./dist/A-0.0.0-docs.tar.gz

cabal-testsuite/PackageTests/NewHaddock/HaddockOutput/HaddockForHackageCmdOutput/cabal.project

@@ -0,0 +1 @@
+packages: A

cabal-testsuite/PackageTests/NewHaddock/HaddockOutput/HaddockForHackageCmdOutput/cabal.test.hs

@@ -0,0 +1,7 @@
+import Test.Cabal.Prelude
+
+-- Test that `cabal haddock --haddock-for-hackage` does not report that it
+-- creates an `index.html` file.
+main = cabalTest $ do
+  r <- cabal' "haddock" ["--haddock-for-hackage", "A"]
+  assertOutputDoesNotContain "index.html" r

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