Merge pull request haskell#10145 from haskell/includes-docs

Improve online docs for `includes:` field
geekosaur · Jul 1, 2024 · 6eaba73 · 6eaba73
2 parents 8466a8f + c7c1a00
commit 6eaba73
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/doc/cabal-package-description-file.rst b/doc/cabal-package-description-file.rst
@@ -1954,6 +1954,11 @@ system-dependent values for these fields.
    Like :pkg-field:`ghc-prof-shared-options` but applies to GHCJS
 
 .. pkg-field:: includes: filename list
+    :since: 1.0
+    :deprecated: 2.0
+
+    From GHC 6.10.1, :pkg-field:`includes` has no effect when compiling with
+    GHC. From Cabal 2.0, support for GHC versions before GHC 6.12 was removed.
 
     A list of header files to be included in any compilations via C.
     This field applies to both header files that are already installed