Skip to content

Better defaults for Cabal config documentation parameter, html-location, content-location #2079

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

Closed
bitemyapp opened this issue Aug 30, 2014 · 4 comments

Comments

@bitemyapp
Copy link
Contributor

https://github.com/bitemyapp/learnhaskell#haddock

Cabal should default documentation to True, html-location and content-location should be parameterized by package and set to Hackage by default.

I'm not the only one that's gotten stuck on this recently and it caught me out after I'd had documentation generating properly in the past.

@bitemyapp bitemyapp changed the title Defaults for Cabal config confuse people Better defaults for Cabal config documentation parameter, html-location, content-location Aug 30, 2014
@23Skidoo
Copy link
Member

Cabal should default documentation to True

I'm +0 on this. What do others think?

html-location and content-location should be parameterized by package and set to Hackage by default.

I never needed this. What is the advantage?

@ttuegel
Copy link
Member

ttuegel commented Aug 30, 2014

Cabal should default documentation to True

I'm +1 on making it the default for cabal-install (i.e., in $HOME/.cabal/config), because developers use that frequently and they want the documentation. I'm -1 on making it the default for Cabal, because that's how many (most?) Linux distros build their packages, and that's how most non-developer users of Haskell programs get their dependencies. They don't want documentation, or if they do, their package manager does it already.

html-location and content-location should be parameterized by package and set to Hackage by default

This is for uploading documentation to Hackage. You probably don't want it for documentation you generate for local use. So, I'm -1 on making these the defaults, but +1 on adding an option cabal haddock --for-hackage and an option cabal upload --haddock and +0.5 on making the latter the default. I was working on a patch for this recently, but I got sidetracked. It's been a big issue because Haddock generation has been broken on Hackage for months now.

@23Skidoo
Copy link
Member

This is for uploading documentation to Hackage.

Ah, ok.

So, I'm -1 on making these the defaults, but +1 on adding an option cabal haddock --for-hackage and an option cabal upload --haddock and +0.5 on making the latter the default.

Yes, something like cabal upload --haddock makes more sense.

@23Skidoo
Copy link
Member

Closing in favour of #2080 and #2081.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants