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

user guide should document new fields with the version of Cabal they appeared in #501

Closed
bos opened this issue May 24, 2012 · 1 comment
Closed

Comments

@bos
Copy link
Contributor

bos commented May 24, 2012

(Imported from Trac #508, reported by @dcoutts on 2009-02-25)

It would be nice if the user guide specified in which Cabal version a field was first introduced. This would help package authors work out compatibility.

With this documented we should also check that cabal check gives the same advice. That is if a package uses a field that is new in version 1.2 say, that cabal check warns if the cabal-version: >=x.y number is not high enough. It should only be a warning not an error because older Cabal versions only warn about unknown fields.

While we're at it, we should document in the user guide that unknown fields give a warning, but should not cause a parse error. This lets people use new non-essential informational fields without having to absolutely require a later Cabal version. Probably a section on version compatibility is wanted.

@tibbe
Copy link
Member

tibbe commented May 15, 2014

Closing as there's been no activity in years.

We're cleaning up the bug tracker to make it useful again and are thus closing bugs that haven't seen any activity in a long time. Please re-open (or file a new bug) if the problem reappears.

@tibbe tibbe closed this as completed May 15, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants