Skip to content

Commit 06dd508

Browse files
committed
Re #6514 Document limitations of Cabal (the library)
1 parent 1817292 commit 06dd508

File tree

1 file changed

+27
-9
lines changed

1 file changed

+27
-9
lines changed

doc/build_command.md

+27-9
Original file line numberDiff line numberDiff line change
@@ -329,11 +329,17 @@ of packages.
329329
If the [`--haddock-for-hackage`](#-no-haddock-for-haddock-flag) flag is passed,
330330
this flag is ignored.
331331

332+
!!! note
333+
334+
This feature is not supported by versions of Cabal (the library) provided
335+
with GHC 9.2.8 and earlier.
336+
332337
!!! warning
333338

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

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

355+
!!! note
356+
357+
This feature is not supported by versions of Cabal (the library) provided
358+
with GHC 9.2.8 and earlier.
359+
349360
!!! warning
350361

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

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

387+
!!! note
388+
389+
This feature is not supported by versions of Cabal (the library) provided
390+
with GHC 9.2.8 and earlier.
391+
375392
!!! warning
376393

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

382400
### `--[no-]keep-going` flag

0 commit comments

Comments
 (0)