Skip to content

Commit f669d09

Browse files
Change packages default to empty (haskell#10118)
(cherry picked from commit e6d9257) Co-authored-by: Phil de Joux <[email protected]>
1 parent 862584a commit f669d09

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

doc/cabal-project-description-file.rst

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,19 +86,25 @@ would not be necessitated.
8686
Specifying the local packages
8787
-----------------------------
8888

89+
You *must* provide a non-empty list of local packages in your project, filling
90+
out either a ``packages`` field or an ``optional-packages`` field or both to
91+
satisfy this requirement.
92+
93+
When ``cabal.project`` doesn't exist, ``cabal-install`` fabricates an ephemeral
94+
project for its own use with this simple content, a glob that will find any (but
95+
expects to find one) package in the current directory:
96+
97+
.. code-block:: cabal
98+
99+
packages: ./*.cabal
100+
89101
The following top-level options specify what the local packages of a
90102
project are:
91103

92104
.. cfg-field:: packages: package location list (space or comma separated)
93105
:synopsis: Project packages.
94106

95-
:default: ``./*.cabal``
96-
97-
.. warning::
98-
99-
The default value ``./*.cabal`` only takes effect if there is no explicit
100-
``cabal.project`` file.
101-
If you use such explicit file you *must* fill the field.
107+
:default: empty
102108

103109
Specifies the list of package locations which contain the local
104110
packages to be built by this project. Package locations can take the

0 commit comments

Comments
 (0)