Merge pull request haskell#10163 from haskell/coot/haddock-all

haddock-project: added `--all` switch
geekosaur · Jul 4, 2024 · 1837262 · 1837262
2 parents e9d41c8 + 4ac692b
commit 1837262
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -344,7 +344,7 @@ description: {
 }
 ```
 
-Only the `synopsis` field is actually required, but you should also set the others where applicable.
+Only the `synopsis` and `prs` fields are required, but you should also set the others where applicable.
 
 | Field          | Description                                                                                                        |
 | -----          | -----------                                                                                                        |

diff --git a/Cabal/src/Distribution/Simple/Setup/Haddock.hs b/Cabal/src/Distribution/Simple/Setup/Haddock.hs
@@ -584,6 +584,27 @@ haddockProjectOptions _showOrParseArgs =
       haddockProjectForeignLibs
       (\v flags -> flags{haddockProjectForeignLibs = v})
       trueArg
+  , option
+      ""
+      ["all", "haddock-all"]
+      "Run haddock for all targets"
+      ( \f ->
+          allFlags
+            [ haddockProjectExecutables f
+            , haddockProjectTestSuites f
+            , haddockProjectBenchmarks f
+            , haddockProjectForeignLibs f
+            ]
+      )
+      ( \v flags ->
+          flags
+            { haddockProjectExecutables = v
+            , haddockProjectTestSuites = v
+            , haddockProjectBenchmarks = v
+            , haddockProjectForeignLibs = v
+            }
+      )
+      trueArg
   , option
       ""
       ["internal"]

diff --git a/changelog.d/issue-10051 b/changelog.d/issue-10051
@@ -0,0 +1,4 @@
+synopsis: Added `--all` and `--haddock-all` switches to `haddock-project` subcommand
+packages: cabal-install
+issues: #10051
+prs: #2272