Support Haskell.nix where possible #58
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
At least one build system [Haskell.nix](https://github.com/input-output-hk/haskell.nix) builds Haskell projects a component at a time. This breaks cabal-doctest's expected usage of getting configuration from the Cabal components for libraries and executables under test. By recording flags for the test component, we introduce another possible usage where all information we need comes from the test component alone. See issue ulidtko#57 for more discussion and details.
We used to only get module sources from library and executable components. So the `Build_doctests` module wouldn't show up. But for issue ulidtko#57 we're now getting module sources for the test suites as well, and Cabal nags us with the warning: <no location info>: warning: [-Wmissing-home-modules] These modules are needed for compilation but not listed in your .cabal file's other-modules: Build_doctests So people are likely to follow the warning and put in Build_doctests into their Cabal file, and then be annoyed that it breaks their tests. Because `Build_doctests` is autogenerated by Cabal-doctests, we know it will never have doctests itself, so it can be safely filtered out.
The main motivation of the commits for issue ulidtko#57 is to make it easier to use Cabal-doctests with Haskell.nix. Haskell.nix has built everything by the time everything is run, so there are no intermediate directories around like `build/` or `dist/`. What Haskell.nix does instead is just make the original source available. So it seems convenient to include not just absolute paths, but relative paths as well. Otherwise, we have to munge the "-i" flags after the fact.
|
@phadej I see you have your status set as busy, but I thought I'd leave a note here for when you're free. I hope these commits is not so bad. I really tried to make the changes small and without impacting prior functionality. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These three commits address issue #57. The main problem is that Haskell.nix builds packages one component at a time with
Setup.hsdirectly, soLocalBuildInfobuild/ordist/) from non-test components aren't available.Changes include:
Build_doctestsfor test componentsBuild_doctestsfrom module sources