Skip to content

Commit 98ece87

Browse files
committed
Document change
1 parent 7ef6be2 commit 98ece87

File tree

3 files changed

+17
-11
lines changed

3 files changed

+17
-11
lines changed

cabal-install/tests/UnitTests/Distribution/Client/Configure.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ configureTests = testGroup "Configure tests"
9898

9999
, testCase "Local program options" $ do
100100
let ghcFlags = ["-fno-full-laziness"]
101-
flags = (defaultNixStyleFlags ())
101+
flags = (defaultNixStyleFlags ())
102102
{ configFlags = mempty
103103
{ configVerbosity = Flag silent
104104
, configProgramArgs = [("ghc", ghcFlags)]

changelog.d/pr-7973

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
synopsis: Apply local options only to local packages
2+
packages: cabal-install
3+
prs: #7973
4+
issues: #7998
5+
6+
description: {
7+
- Command-line `ghc-options` only applies to local packages
8+
- `program-options` stanza only applies to local packages
9+
}

doc/cabal-project.rst

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -643,16 +643,13 @@ an external dependency) should be built with ``-fno-state-hack``::
643643
package bytestring
644644
ghc-options: -fno-state-hack
645645

646-
``ghc-options`` is not specifically described in this documentation,
647-
but is one of many fields for configuring programs. They take the form
648-
``progname-options`` and ``progname-location``, and
649-
can only be set inside package stanzas. (TODO: They are not supported
650-
at top-level, see :issue:`3579`.)
651-
652-
At the moment, there is no way to specify an option to apply to all
653-
external packages or all inplace packages. Additionally, it is only
654-
possible to specify these options on the command line for all local
655-
packages (there is no per-package command line interface.)
646+
``ghc-options`` is not specifically described in this documentation, but is one
647+
of many fields for configuring programs. They take the form
648+
``progname-options`` and ``progname-location``, and can be set for all local
649+
packages in a ``program-options`` stanza or under a package stanza.
650+
651+
On the command line, these options are applied to all local packages.
652+
There is no per-package command line interface.
656653

657654
Some flags were added by more recent versions of the Cabal library. This
658655
means that they are NOT supported by packages which use Custom setup

0 commit comments

Comments
 (0)