Skip to content

Commit 81c0fb5

Browse files
committed
Re #6125: document that glob-dirs are buggy in Cabal 2.4
`cabal-version: 2.4` allows e.g. `data-files: foo/**/*.txt` but `**` directories are only handled correctly since Cabal 3.0 (issue #6125). This information should be part of the cabal file format history documentation.
1 parent dcba107 commit 81c0fb5

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

doc/cabal-package.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -763,7 +763,8 @@ describe the package as a whole:
763763
behaviour, put the files that wildcards will match against in
764764
their own folder.
765765

766-
``**`` wildcards are available starting in Cabal 2.4.
766+
``**`` wildcards are available starting in Cabal 2.4
767+
and `bug-free since Cabal 3.0 <https://github.com/haskell/cabal/issues/6125#issuecomment-1379878419>`_.
767768

768769
.. pkg-field:: data-dir: directory
769770

doc/file-format-changelog.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,10 @@ relative to the respective preceding *published* version.
161161
``foo/**/bar.html`` are all invalid). As ``**`` was an error in
162162
globs before, this does not affect any existing ``.cabal`` files
163163
that previously worked.
164+
(Caveat: Double-star wildcards in :pkg-field:`data-files` directories,
165+
e.g. ``data-files: data/**/*.csv``,
166+
`are only supported correctly from Cabal 3.0 <https://github.com/haskell/cabal/issues/6125#issuecomment-1379878419>`_.)
167+
164168

165169
* Wildcards now match when the pattern's extensions form a suffix of
166170
the candidate file's extension, rather than requiring strict

0 commit comments

Comments
 (0)