Skip to content

Set 'documentation' and 'hyperlink-source' to True by default. #2082

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 4 commits into from
Closed

Set 'documentation' and 'hyperlink-source' to True by default. #2082

wants to merge 4 commits into from

Conversation

23Skidoo
Copy link
Member

Fixes #2081.

Note that this only affects cabal-install, not Cabal itself (i.e. the behaviour of runghc Setup.hs * won't be changed).

@23Skidoo 23Skidoo force-pushed the default-haddock branch 2 times, most recently from 0fa9268 to dc96bc4 Compare August 31, 2014 05:04
@23Skidoo 23Skidoo force-pushed the default-haddock branch 2 times, most recently from 0fbf3a7 to baf416f Compare September 8, 2014 01:09
@23Skidoo
Set 'documentation' and 'hyperlink-source' to True by default.
7f6e60c 
Note that this only affects 'cabal-install', not Cabal itself.
@23Skidoo
Add a non-throwing variant of 'requireProgramVersion'.
3098103
@23Skidoo
Formatting, 80-col violations.
56de564
@23Skidoo
'cabal haddock': warn instead of dying when 'hscolour' isn't installed.
1e7a468 
This means that if 'hyperlink-source' is set to True, but the 'HsColour'
executable is not present, documentation will be still generated.

Note that 'cabal hscolour' will still exit with error in this case.
@23Skidoo 23Skidoo mentioned this pull request Oct 21, 2014
Open
@23Skidoo
Copy link
Member Author

Closing in favour of #2172.

@23Skidoo 23Skidoo closed this Oct 21, 2014
@23Skidoo 23Skidoo deleted the default-haddock branch October 21, 2014 20:43
@amigalemming
Copy link
Contributor

When I add

hyperlink-source: True

or

haddock-hyperlink-source: True

to .cabal/config I get the warning:

Warning: .cabal/config: Unrecognized field
haddock-hyperlink-source on line 57

I am using Cabal-1.24.

@23Skidoo
Copy link
Member Author

23Skidoo commented Feb 6, 2017

@amigalemming Use the haddock section:

haddock
  -- keep-temp-files: False
  -- hoogle: False
  -- html: False
  -- html-location:
  -- executables: False
  -- tests: False
  -- benchmarks: False
  -- all:
  -- internal: False
  -- css:
  -- hyperlink-source: False
  -- hscolour-css:
  -- contents-location:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Make documentation: True the default for cabal-install
2 participants
@23Skidoo @amigalemming