cabal haddock --executables fails with "internal error when calculating transitive package dependencies" #1919

massysett · 2014-06-04T00:01:23Z

When running

cabal haddock --executables

the command fails with

cabal: internal error when calculating transitive package dependencies.
Debug info: []

I have tagged my source code tree where this problem exists:

https://github.com/massysett/penny/tree/cabal_error

This is cabal-install version 1.20.0.2.

The text was updated successfully, but these errors were encountered:

mietek · 2014-06-26T01:21:49Z

@kosmikus: I have prepared a minimal Cabal package reproducing this error.

With GHC 7.8.2 and cabal 1.20.0.2:

$ git clone https://github.com/mietek/cabal-fail-one.git
$ cd cabal-fail-one
$ make
cabal sandbox init
Writing a default package environment file to
/Users/mietek/Projects/Haskell/cabal-fail-one/cabal.sandbox.config
Creating a new sandbox at
/Users/mietek/Projects/Haskell/cabal-fail-one/.cabal-sandbox
cabal install \
      --dependencies-only \
      --enable-documentation \
      --enable-tests \
      --reorder-goals
Resolving dependencies...
All the requested packages are already installed:
Use --reinstall if you want to reinstall anyway.
cabal configure --enable-tests
Resolving dependencies...
Configuring cabal-fail-one-0.1...
cabal test --show-details=streaming
Building cabal-fail-one-0.1...
Preprocessing library cabal-fail-one-0.1...
[1 of 1] Compiling Cabal.Fail.One   ( src/lib/Cabal/Fail/One.hs, dist/build/Cabal/Fail/One.o )
In-place registering cabal-fail-one-0.1...
Preprocessing executable 'cabal-fail-one' for cabal-fail-one-0.1...
[1 of 1] Compiling Main             ( src/cabal-fail-one.hs, dist/build/cabal-fail-one/cabal-fail-one-tmp/Main.o )
Linking dist/build/cabal-fail-one/cabal-fail-one ...
Preprocessing test suite 'test' for cabal-fail-one-0.1...
[1 of 1] Compiling Main             ( test/test.hs, dist/build/test/test-tmp/Main.o )
Linking dist/build/test/test ...
Running 1 test suites...
Test suite test: RUNNING...
Test suite test: PASS
Test suite logged to: dist/test/cabal-fail-one-0.1-test.log
1 of 1 test suites (1 of 1 test cases) passed.
cabal haddock --executables
Running Haddock for cabal-fail-one-0.1...
Preprocessing library cabal-fail-one-0.1...
Haddock coverage:
   0% (  0 /  1) in 'Cabal.Fail.One'
Documentation created: dist/doc/html/cabal-fail-one/index.html
Preprocessing executable 'cabal-fail-one' for cabal-fail-one-0.1...
cabal: internal error when calculating transitive package dependencies.
Debug info: []
make: *** [doc] Error 1

#1085 may be a related ticket.

relrod · 2014-11-02T21:16:23Z

Seeing this error on one of my projects as well.

creichert · 2014-12-15T05:58:42Z

I can confirm this error as well with the --executable flag.

creichert · 2014-12-18T20:34:49Z

I've tracked this error down to the dependencyClosure function.

cabal/cabal-install/Distribution/Client/PackageIndex.hs

Line 346 in 5c70361

dependencyClosure :: PackageFixedDeps pkg

From the local documentation:

Note that if the result is @right []@ it is because at least one of the original given
'PackageIdentifier's do not occur in the index.

It seems to be a problem resolving the inplace package dependency of the local library. When I remove that dependency I am able to generate the haddocks for the executable.

Would anyone familiar with the cabal code be able to give me anymore pointers for digging into this more? I don't mind spending more time to fix this.

taladar · 2015-03-29T20:23:26Z

Has any progress been made on this issue? We have some projects with significant code in the modules which only appear in the executable and it would be great if documentation could be generated for those as well. Of course removing the dependency on the local library is not really an option.

edsko · 2016-06-20T02:06:56Z

This problem still occurs with 1.24.0.0.

alexbiehl · 2018-10-27T00:46:23Z

I think this is fixed with latest Cabal. Christopher Lewis <notifications@github.com> schrieb am Sa., 27. Okt. 2018, 06:54:

…

This problem is also present in 2.2.0.1. — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#1919 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AByiie6zza8agAdypNbxg2ile2qvVlkBks5uo5KNgaJpZM4CA20M> .

int-e · 2019-02-14T14:20:18Z

FWIW, this bug still exists for the v1-haddock command in cabal-install 2.4.1.0. It occurs when an executable depends on the library defined in the current package.

mietek · 2019-02-14T16:11:51Z

My cabal-fail-one repository is now named cabal-issue-1919.

int-e · 2019-02-14T16:30:58Z

Note that new-haddock is affected by a different issue that also causes executable documentation to not be built in some cases (including @mietek's repository, I think): #5890.

madgen · 2019-10-17T13:20:28Z

I get the same error when I use cabal haddock on a package with internal libraries with Cabal 2.4.1.0. Since Stack currently supports up to Cabal 2.4, I imagine this affects some number of people.

Is the only workaround to just not use internal libraries? Does anyone have an idea where to start poking to work towards a patch?

Due to a bug about haddock, cabal, and intenal libraries (haskell/cabal#1919), `haddock` fails, so remove it from CI for now.

hsenag · 2020-08-23T16:40:28Z

FYI I'm getting this on darcs 2.16.2:

$ cabal unpack darcs-2.16.2
Unpacking to darcs-2.16.2\
$ cd darcs-2.16.2
$ cabal v2-haddock test:darcs-test --enable-tests --enable-documentation --haddock-tests
[...]
Running Haddock on test suite 'darcs-test' for darcs-2.16.2..
setup.exe: internal error when calculating transitive package dependencies.
Debug info: []

I'm using cabal-install 3.2 on Windows:

cabal-install version 3.2.0.0
compiled using version 3.2.0.0 of the Cabal library

brandon-leapyear · 2021-06-04T20:28:47Z

✨ This is an old work account. Please reference @brandonchinn178 for all future communication ✨

Seems like this is still an issue? I'm surprised this issue is still open after 7 years. Is there any progress yet? Is this work blocked by another issue, or can it be worked on today?

Mikolaj · 2021-06-04T20:36:58Z

I don't see any label suggesting this is blocked (e.g., on a haddock bug), so I guess any work on this would be very welcome.

I'm surprised this is still failing: I'm running haddock on projects with multiple libraries and it works for me (even if it's rather useless until this haddock work is streamlined: haskell/haddock#1379). Apparently the pattern of internal library deps matters.

brandon-leapyear · 2021-06-04T21:09:01Z

✨ This is an old work account. Please reference @brandonchinn178 for all future communication ✨

Here's an up-to-date minimal repro: https://github.com/brandonchinn178/cabal-repro-1919

Mikolaj · 2021-06-04T21:25:48Z

It works for me with development version of cabal (I run cabal haddock. Which version and what commandline do you use?

brandon-leapyear · 2021-06-04T21:51:20Z

✨ This is an old work account. Please reference @brandonchinn178 for all future communication ✨

oh interesting. It fails with stack haddock. With debugging enabled, I see it failing when running

.../.stack/setup-exe-cache/x86_64-osx/Cabal-simple_mPHDZzAJ_3.2.1.0_ghc-8.10.4 --builddir=.stack-work/dist/x86_64-osx/Cabal-3.2.1.0 haddock --html --hoogle --html-location=../$pkg-$version/ --haddock-option=--hyperlinked-source --haddock-option=--quickjump

so maybe it's a GHC bug?

EDIT: never mind, this is the cabal executable built by stack

Mikolaj · 2021-06-05T00:24:46Z

Could you make stack build a newer cabal executable? Preferably dev version from branch master? This one looks like 3.2 and it works fine with 3.5 for me and the invocation you show does not see particularly wild, so perhaps this was fixed already?

brandon-leapyear · 2021-06-05T01:31:52Z

✨ This is an old work account. Please reference @brandonchinn178 for all future communication ✨

Hm so I checked out the Cabal-v3.4.0.0 tag to build 3.4, and then running cabal haddock worked. But then using Cabal 3.4 with Stack still fails

$ /Users/bchinn/.stack/setup-exe-cache/x86_64-osx/Cabal-simple_mPHDZzAJ_3.4.0.0_ghc-9.0.1 --builddir=.stack-work/dist/x86_64-osx/Cabal-3.4.0.0 haddock

Preprocessing library for foo-0.1.0.0..
Running Haddock on library for foo-0.1.0.0..
Haddock coverage:
   0% (  0 /  2) in 'Foo'
  Missing documentation for:
    Module header
    doThing (src/Foo.hs:3)
Documentation created:
.stack-work/dist/x86_64-osx/Cabal-3.4.0.0/doc/html/foo/index.html
Preprocessing library 'foo-internal' for foo-0.1.0.0..
Running Haddock on library 'foo-internal' for foo-0.1.0.0..
Cabal-simple_mPHDZzAJ_3.4.0.0_ghc-9.0.1: internal error when calculating
transitive package dependencies.
Debug info: []

So it's probably a Stack bug.

I believe this issue can be closed. Mostly because cabal haddock --executables seems to not be a thing anymore

Mikolaj · 2021-06-05T08:42:58Z

It would still be nice to report on Stack issue tracker and perhaps improve Cabal to avoid this problem, if it's more on our side.

brandon-leapyear · 2021-06-05T19:26:26Z

✨ This is an old work account. Please reference @brandonchinn178 for all future communication ✨

It is tracked for Stack: commercialhaskell/stack#4428

But it actually might be a bug in GHC/Cabal, now that I'm digging further. Can you clone my minimal repro again (https://github.com/brandonchinn178/stack-repro-4428) and do the following:

ghc-9.0.1 -package Cabal-3.4.0.0 Setup.hs -o setup
./setup configure
./setup haddock

brandon-leapyear · 2021-06-05T22:20:16Z

✨ This is an old work account. Please reference @brandonchinn178 for all future communication ✨

Ok I think I have a better idea of what's going on.

It seems that when calling cabal haddock, the haddock function (from Distribution.Simple.Haddock) is called separately for each component (in the minimal repro, the foo library, and the foo-internal internal library), so when building the haddocks for foo-internal, the foo library is registered.

But when manually building Setup.hs and calling haddock via Cabal-the-library, the haddock function is called once for everything, so when building the haddocks for foo-internal, the foo library doesn't exist.

Technical details

cabal haddock

haddock is called first with LocalBuildInfo containing:

configFlags.configArgs = ["lib:foo"]
componentEnabledSpec = OneComponentRequestedSpec (CLibName LMainLibName)
installedPkgs.unitIdIndex containing:

base-4.14.1.0
ghc-prim-0.6.1
integer-gmp-1.0.3.0
rts

Then haddock is called with LocalBuildInfo containing:

configFlags.configArgs = ["lib:foo-internal"]
componentEnabledSpec = OneComponentRequestedSpec (CLibName (LSubLibName (UnqualComponentName "foo-internal")))
installedPkgs.unitIdIndex containing:

base-4.14.1.0
foo-0.1.0.0-inplace
ghc-prim-0.6.1
integer-gmp-1.0.3.0
rts

Setup.hs, Cabal-the-library

haddock is called once with LocalBuildInfo containing:

configFlag.configArgs = []
componentEnabledSpec = ComponentRequestedSpec {testsRequested = False, benchmarksRequested = False}
installedPkgs.unitIdIndex containing:

base-4.14.1.0
ghc-prim-0.6.1
integer-gmp-1.0.3.0
rts

Mikolaj · 2021-06-07T09:07:09Z

Reproduced. Got setup: internal error when calculating transitive package dependencies. What does ./setup configure even do?

So it looks like cabal problem? The Setup way outdated vs the v2 way?

23Skidoo added the type: bug label Mar 29, 2015

ttuegel added this to the cabal-install-1.24 milestone Apr 24, 2015

rimmington mentioned this issue Aug 7, 2015

[RFC] Handle executables depending on package library for Haddock #2753

Closed

23Skidoo modified the milestones: cabal-install 1.24, cabal-install 1.26 Feb 21, 2016

mgsloan mentioned this issue Mar 3, 2016

Provide stack haddock --executables commercialhaskell/stack#729

Closed

23Skidoo added Cabal: other priority: high 🔥 labels Jul 18, 2016

23Skidoo self-assigned this Jul 18, 2016

23Skidoo added the meta: 23Skidoo label Jul 27, 2016

23Skidoo removed their assignment Jul 27, 2016

23Skidoo mentioned this issue Jul 30, 2016

Componentized Cabal ghc-proposals/ghc-proposals#4

Closed

ezyang added the old-milestone: cabal-install 2.0 label Sep 6, 2016

ezyang modified the milestone: cabal-install 2.0 Sep 6, 2016

abooij mentioned this issue Jan 14, 2017

cabal haddock fails for foreign libraries #4215

Open

This was referenced Dec 22, 2017

cabal haddock fails with internal libraries #4969

Closed

'cabal haddock --executables' causes "cabal: internal error when calculating transative package dependencies." #1085

Closed

23Skidoo added Cabal: cmd/haddock and removed Cabal: other old-milestone: cabal-install 2.0 labels Dec 22, 2017

grayjay added the cabal-install: cmd/haddock label Jun 20, 2018

qrilka mentioned this issue Feb 19, 2019

stack haddock: internal error when calculating transitive package dependencies. commercialhaskell/stack#4428

Closed

madgen pushed a commit to madgen/exalog that referenced this issue Oct 17, 2019

Don't build haddock in CI

c41395a

Due to a bug about haddock, cabal, and intenal libraries (haskell/cabal#1919), `haddock` fails, so remove it from CI for now.

madgen mentioned this issue Oct 17, 2019

Can't build documentation madgen/exalog#1

Open

Anviking mentioned this issue Feb 20, 2020

Create new cardano-wallet-core-arbitrary library & move Cardano.Wallet.Gen there cardano-foundation/cardano-wallet#1363

Closed

1 task

madgen mentioned this issue May 8, 2020

"Internal error when calculating transitive package dependencies" running stack haddock commercialhaskell/stack#5284

Closed

Mikolaj added blocked: info-needed resolution: not our bug and removed meta: 23Skidoo priority: high 🔥 labels Jun 5, 2021

brandonchinn178 mentioned this issue Nov 19, 2021

Fix haddock via Setup.hs with internal libraries #7827

Merged

3 tasks

mergify bot closed this as completed in #7827 Jan 30, 2022

RyanGlScott mentioned this issue Aug 22, 2022

cabal new-haddock regression (setup: internal error when calculating transitive package dependencies.) #5423

Open

ProgMiner mentioned this issue Dec 2, 2022

ghc: Add patch for haskell/cabal#1919 gentoo-haskell/gentoo-haskell#1366

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cabal haddock --executables fails with "internal error when calculating transitive package dependencies" #1919

cabal haddock --executables fails with "internal error when calculating transitive package dependencies" #1919

massysett commented Jun 4, 2014

mietek commented Jun 26, 2014

relrod commented Nov 2, 2014

creichert commented Dec 15, 2014

creichert commented Dec 18, 2014

taladar commented Mar 29, 2015

edsko commented Jun 20, 2016

alexbiehl commented Oct 27, 2018 via email

int-e commented Feb 14, 2019

mietek commented Feb 14, 2019

int-e commented Feb 14, 2019

madgen commented Oct 17, 2019

hsenag commented Aug 23, 2020

brandon-leapyear commented Jun 4, 2021 •

edited

Loading

Mikolaj commented Jun 4, 2021

brandon-leapyear commented Jun 4, 2021 •

edited

Loading

Mikolaj commented Jun 4, 2021

brandon-leapyear commented Jun 4, 2021 •

edited

Loading

Mikolaj commented Jun 5, 2021

brandon-leapyear commented Jun 5, 2021 •

edited

Loading

Mikolaj commented Jun 5, 2021

brandon-leapyear commented Jun 5, 2021 •

edited

Loading

brandon-leapyear commented Jun 5, 2021 •

edited

Loading

Mikolaj commented Jun 7, 2021

cabal haddock --executables fails with "internal error when calculating transitive package dependencies" #1919

cabal haddock --executables fails with "internal error when calculating transitive package dependencies" #1919

Comments

massysett commented Jun 4, 2014

mietek commented Jun 26, 2014

relrod commented Nov 2, 2014

creichert commented Dec 15, 2014

creichert commented Dec 18, 2014

taladar commented Mar 29, 2015

edsko commented Jun 20, 2016

alexbiehl commented Oct 27, 2018 via email

int-e commented Feb 14, 2019

mietek commented Feb 14, 2019

int-e commented Feb 14, 2019

madgen commented Oct 17, 2019

hsenag commented Aug 23, 2020

brandon-leapyear commented Jun 4, 2021 • edited Loading

Mikolaj commented Jun 4, 2021

brandon-leapyear commented Jun 4, 2021 • edited Loading

Mikolaj commented Jun 4, 2021

brandon-leapyear commented Jun 4, 2021 • edited Loading

Mikolaj commented Jun 5, 2021

brandon-leapyear commented Jun 5, 2021 • edited Loading

Mikolaj commented Jun 5, 2021

brandon-leapyear commented Jun 5, 2021 • edited Loading

brandon-leapyear commented Jun 5, 2021 • edited Loading

Technical details

cabal haddock

Setup.hs, Cabal-the-library

Mikolaj commented Jun 7, 2021

brandon-leapyear commented Jun 4, 2021 •

edited

Loading

brandon-leapyear commented Jun 4, 2021 •

edited

Loading

brandon-leapyear commented Jun 4, 2021 •

edited

Loading

brandon-leapyear commented Jun 5, 2021 •

edited

Loading

brandon-leapyear commented Jun 5, 2021 •

edited

Loading

brandon-leapyear commented Jun 5, 2021 •

edited

Loading