Skip to content
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

unbreak cabal haddock --disable-documentation #8330

Merged
merged 1 commit into from
Aug 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion cabal-install/src/Distribution/Client/CmdHaddock.hs
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,8 @@ haddockAction flags@NixStyleFlags {..} targetStrings globalFlags = do
runProjectPostBuildPhase verbosity baseCtx buildCtx' buildOutcomes
where
verbosity = fromFlagOrDefault normal (configVerbosity configFlags)
flags' = flags { installFlags = installFlags { installDocumentation = Flag True } }
installDoc = fromFlagOrDefault True (installDocumentation installFlags)
flags' = flags { installFlags = installFlags { installDocumentation = Flag installDoc } }
cliConfig = commandLineFlagsToProjectConfig globalFlags flags' mempty -- ClientInstallFlags, not needed here

-- | This defines what a 'TargetSelector' means for the @haddock@ command.
Expand Down
12 changes: 12 additions & 0 deletions cabal-testsuite/PackageTests/NewHaddock/DisableDoc/B/B.cabal
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: a.pelenitsyn@gmail.com

library
exposed-modules: B
build-depends: base
, A
hs-source-dirs: .
default-language: Haskell2010
8 changes: 8 additions & 0 deletions cabal-testsuite/PackageTests/NewHaddock/DisableDoc/B/B.hs
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
16 changes: 16 additions & 0 deletions cabal-testsuite/PackageTests/NewHaddock/DisableDoc/cabal.out
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# 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..
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
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
packages: B
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import Test.Cabal.Prelude
-- Test that `cabal haddock --disable-documention` works as expected and leads
-- to a warning if a local package makes an outer reference.
Comment on lines +2 to +3
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we perhaps extend the test to also display the warning (for some other module?)? The very text of the warning may be fragile, but if we notice we need to update it too often as haddock gets message overhauls, we can grep for a couple of keywords instead.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. See the assert below. Is it good?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I see you approved, so I guess it's good.

main = cabalTest . withRepo "repo" $ do
r <- cabal' "haddock" ["--disable-documentation", "B"]
assertOutputContains "Warning: B: could not find link destinations for" r
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: a.pelenitsyn@gmail.com

library
exposed-modules: A
build-depends: base
hs-source-dirs: .
default-language: Haskell2010
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
module A (a) where

a :: Int
a = 42