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

Drop >= for cabal-version going forward. #5131

Closed
wants to merge 1 commit into from
Closed

Conversation

angerman
Copy link
Collaborator

@angerman angerman commented Feb 9, 2018

See #5108. We want >= to not be used anymore.

Please include the following checklist in your PR:

  • Patches conform to the coding conventions.
  • Any changes that could be relevant to users have been recorded in the changelog.
  • The documentation has been updated, if necessary.
  • If the change is docs-only, [ci skip] is used to avoid triggering the build bots.

Please also shortly describe how you tested your change. Bonus points for added tests!

ci skip

See #5108. We want `>=` to not be used anymore.
@angerman
Copy link
Collaborator Author

angerman commented Feb 9, 2018

Question: should we just drop the >= in cabal-version: >= from the whole documentation going forward?

@phadej
Copy link
Collaborator

phadej commented Feb 9, 2018

@angerman thanks for picking this up!

I'm 👍, but I think we need to amend this with >= 1.10 case (as then it's still required) and points from #5108

@hvr
Copy link
Member

hvr commented Feb 9, 2018

@angerman Great that you started on this; I intended to update the docs for cabal-version at some point anyway to document some other aspects that have changed. But as far as your PR is concerned, I'd just add a historical comment about the historical syntax for pre-1.12 as it's still part of the (historic) cabal spec. One thing that should be also noted is that cabal-install clients prioer to 1.12 will likely not be able to consume today's 00-index.tar, as they'd choke on all the cabal-version: files which omit the >=; there's quite a few of those by now.

EDIT: typo (I typed ^>= instead of >=)

@ntc2
Copy link

ntc2 commented May 30, 2019

If you were brought here by a Cabal error message and just want to fix your Cabal file, replace

cabal-version: >= 2.2

with

cabal-version: 2.2

and move the cabal-version: declaration to the first line of your .cabal file.

@m-renaud
Copy link
Collaborator

m-renaud commented Apr 2, 2020

It appears the docs were updated in some other commit along the way (see https://www.haskell.org/cabal/users-guide/developing-packages.html#pkg-field-cabal-version), so I'm going to close out this PR. Sorry we didn't get yours merged sooner.

@m-renaud m-renaud closed this Apr 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants