-
Notifications
You must be signed in to change notification settings - Fork 711
cabal haddock imply enable-documentation #8259
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
12 changes: 12 additions & 0 deletions
12
cabal-testsuite/PackageTests/NewHaddock/ImplyDependencies/B/B.cabal
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
cabal-version: 2.4 | ||
name: B | ||
version: 0.1.0.0 | ||
author: Artem Pelenitsyn | ||
maintainer: [email protected] | ||
|
||
library | ||
exposed-modules: B | ||
build-depends: base | ||
, A | ||
hs-source-dirs: . | ||
default-language: Haskell2010 |
8 changes: 8 additions & 0 deletions
8
cabal-testsuite/PackageTests/NewHaddock/ImplyDependencies/B/B.hs
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
-- | Module using external dependency and mentioning it in haddocks | ||
module B (b) where | ||
|
||
import A | ||
|
||
-- | Use 'a' | ||
b :: Int | ||
b = a |
19 changes: 19 additions & 0 deletions
19
cabal-testsuite/PackageTests/NewHaddock/ImplyDependencies/cabal.out
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# cabal v2-update | ||
Downloading the latest package list from test-local-repo | ||
# cabal haddock | ||
Resolving dependencies... | ||
Build profile: -w ghc-<GHCVER> -O1 | ||
In order, the following will be built: | ||
- A-0.1.0.0 (lib) (requires build) | ||
- B-0.1.0.0 (lib) (first run) | ||
Configuring library for A-0.1.0.0.. | ||
Preprocessing library for A-0.1.0.0.. | ||
Building library for A-0.1.0.0.. | ||
Preprocessing library for A-0.1.0.0.. | ||
Running Haddock on library for A-0.1.0.0.. | ||
Documentation created: dist/doc/html/A/index.html | ||
Installing library in <PATH> | ||
Configuring library for B-0.1.0.0.. | ||
Preprocessing library for B-0.1.0.0.. | ||
Running Haddock on library for B-0.1.0.0.. | ||
Documentation created: <ROOT>/cabal.dist/work/dist/build/<ARCH>/ghc-<GHCVER>/B-0.1.0.0/doc/html/B/index.html |
1 change: 1 addition & 0 deletions
1
cabal-testsuite/PackageTests/NewHaddock/ImplyDependencies/cabal.project
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
packages: B |
6 changes: 6 additions & 0 deletions
6
cabal-testsuite/PackageTests/NewHaddock/ImplyDependencies/cabal.test.hs
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
import Test.Cabal.Prelude | ||
-- Test that `cabal haddock` doesn't require explicit | ||
-- `--enable-dependencies` to happily process links to external packages. | ||
-- In this example package B depends on an external package A. | ||
main = cabalTest . withRepo "repo" $ | ||
cabal "haddock" ["B"] |
11 changes: 11 additions & 0 deletions
11
cabal-testsuite/PackageTests/NewHaddock/ImplyDependencies/repo/A-0.1.0.0/A.cabal
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
cabal-version: 2.4 | ||
name: A | ||
version: 0.1.0.0 | ||
author: Artem Pelenitsyn | ||
maintainer: [email protected] | ||
|
||
library | ||
exposed-modules: A | ||
build-depends: base | ||
hs-source-dirs: . | ||
default-language: Haskell2010 |
4 changes: 4 additions & 0 deletions
4
cabal-testsuite/PackageTests/NewHaddock/ImplyDependencies/repo/A-0.1.0.0/A.hs
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
module A (a) where | ||
|
||
a :: Int | ||
a = 42 |
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
synopsis: `cabal haddock` now implies `--enable-documentation` | ||
packages: cabal-install | ||
issues: #7462 | ||
prs: #8259 |
This file contains hidden or 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can it be that this unconditional setting leads to
--disable-doc
being ignored?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I think you're right.