Skip to content

Clearly state that invalid fields are ignored #6151

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
wants to merge 1 commit into from

Conversation

bgamari
Copy link
Contributor

@bgamari bgamari commented Jul 21, 2019

Previously we would issue a warning of the following form when
we encountered a field that isn't supported by the cabal-version
declared in the cabal file:

Warning: ghc-heap.cabal:30:3: The field "cmm-sources" is available
only since the Cabal specification version 3.0.

The message, however, doesn't tell the user the consequence of this
warning. Consequently a user could easily be confused when the build
subsequently fail.

Avoid this possibility by clearly stating that the field value will be
ignored.


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!

Previously we would issue a warning of the following form when
we encountered a field that isn't supported by the cabal-version
declared in the cabal file:

    Warning: ghc-heap.cabal:30:3: The field "cmm-sources" is available
    only since the Cabal specification version 3.0.

The message, however, doesn't tell the user the consequence of this
warning. Consequently a user could easily be confused when the build
subsequently fail.

Avoid this possibility by clearly stating that the field value will be
ignored.
@bgamari bgamari force-pushed the wip/ignore-invalid-fields branch from a2cd910 to 249343c Compare July 21, 2019 18:20
@bgamari
Copy link
Contributor Author

bgamari commented Jul 21, 2019

This arose out of the discussion on #5819.

@phadej
Copy link
Collaborator

phadej commented Jul 21, 2019

One need to --accept parser-tests

@phadej
Copy link
Collaborator

phadej commented Aug 3, 2019

Merged in #6173

@phadej phadej closed this Aug 3, 2019
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

Successfully merging this pull request may close these issues.

2 participants