Skip to content

Commit

Permalink
Re #6514 Document limitations of Cabal (the library)
Browse files Browse the repository at this point in the history
  • Loading branch information
mpilgrem committed Mar 10, 2024
1 parent 1817292 commit 06dd508
Showing 1 changed file with 27 additions and 9 deletions.
36 changes: 27 additions & 9 deletions doc/build_command.md
Original file line number Diff line number Diff line change
Expand Up @@ -329,11 +329,17 @@ of packages.
If the [`--haddock-for-hackage`](#-no-haddock-for-haddock-flag) flag is passed,
this flag is ignored.

!!! note

This feature is not supported by versions of Cabal (the library) provided
with GHC 9.2.8 and earlier.

!!! warning

Due to a bug, if there is more than one executable (including test suites
and benchmarks) in a project package or more than one project package with
an executable, the Haddock documentation for the `Main` module of one
Due to a bug in versions of Cabal (the library) provided with GHC 9.8.2 and
earlier, if there is more than one executable (including test suites and
benchmarks) in a project package or more than one project package with an
executable, the Haddock documentation for the `Main` module of one
executable will overwrite the Haddock documentation for others.

### `--[no-]haddock-executables` flag
Expand All @@ -346,11 +352,17 @@ of packages.
If the [`--haddock-for-hackage`](#-no-haddock-for-haddock-flag) flag is passed,
this flag is ignored.

!!! note

This feature is not supported by versions of Cabal (the library) provided
with GHC 9.2.8 and earlier.

!!! warning

Due to a bug, if there is more than one executable (including test suites
and benchmarks) in a project package or more than one project package with
an executable, the Haddock documentation for the `Main` module of one
Due to a bug in versions of Cabal (the library) provided with GHC 9.8.2 and
earlier, if there is more than one executable (including test suites and
benchmarks) in a project package or more than one project package with an
executable, the Haddock documentation for the `Main` module of one
executable will overwrite the Haddock documentation for others.

### `--[no-]haddock-internal` flag
Expand All @@ -372,11 +384,17 @@ of packages.
If the [`--haddock-for-hackage`](#-no-haddock-for-haddock-flag) flag is passed,
this flag is ignored.

!!! note

This feature is not supported by versions of Cabal (the library) provided
with GHC 9.2.8 and earlier.

!!! warning

Due to a bug, if there is more than one executable (including test suites
and benchmarks) in a project package or more than one project package with
an executable, the Haddock documentation for the `Main` module of one
Due to a bug in versions of Cabal (the library) provided with GHC 9.8.2 and
earlier, if there is more than one executable (including test suites and
benchmarks) in a project package or more than one project package with an
executable, the Haddock documentation for the `Main` module of one
executable will overwrite the Haddock documentation for others.

### `--[no-]keep-going` flag
Expand Down

0 comments on commit 06dd508

Please sign in to comment.