Build haddocks for dependencies (#143) #362
Merged
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
|
Will review tomorrow. |
|
I merged with master and ran all of the tests locally, which passed. Pushing that merge back onto the 143-haddock-deps branch. |
| @@ -593,6 +596,16 @@ singleBuild ac@ActionContext {..} ee@ExecuteEnv {..} task@Task {..} = | |||
| TTLocal lp -> "build" : map T.unpack (Set.toList $ lpComponents lp) | |||
| TTUpstream _ _ -> ["build"] | |||
|
|
|||
| when (shouldBuildHaddock eeBuildOpts eeWanted (packageName package) && | |||
| packageHasLibrary package && | |||
There was a problem hiding this comment.
Is this redundant with packageHasExposedModules? If not, under what circumstances may it be necessary? If it is redundant, looks like a good place to use assert.
There was a problem hiding this comment.
Pretty sure it's redundant (I think I wrote this before I added the packageHasExposedModules check to shouldBuildHaddock).
snoyberg
added a commit
that referenced
this pull request
Jun 21, 2015
Build haddocks for dependencies (#143)
|
LGTM, nice work! |
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.
This doesn't yet generate the index or do relative links, and it requires rebuilding the package in order to generate haddocks, but does work well in my testing and think it's worth merging with the current feature set (especially as this touches enough code that conflicts are frequent).
As for building haddocks without rebuilding the packages: this should be doable by adding some extra logic to singleBuild that lets it skip
runhaskell Setup.hs buildwhen building only haddocks (along with some adjustments to ConfigCache and maybe getInstalled), but interested in opinion about whether that's the right approach or if this would be better done at the Plan level (i.e. split the plan into build, haddock, and install steps). Note that haddocks need to be built before installing the package (that way, install takes care of putting them where they belong).For #143.