[GHC] #11583: Make warning names more consistent
#11583: Make warning names more consistent -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: task | Status: new Priority: normal | Milestone: 8.2.1 Component: Compiler | Version: 7.10.3 Keywords: | Operating System: Unknown/Multiple Architecture: | Type of failure: None/Unknown Unknown/Multiple | Test Case: | Blocked By: Blocking: | Related Tickets: Differential Rev(s): | Wiki Page: -------------------------------------+------------------------------------- Sven Panne points out that current warning naming conventions used in GHC are rather inconsistent. Since we are moving away from `-fwarn-` to `-W` it would be nice if we could also try to fix up the names themselves. We do, however, want to make sure that transition isn't more painful for users than necessary. For instance, the user should be able to get useful feedback from the compiler on what warning flags have changed with `s/-fwarn-/-W/` To this end I recommend the following, * We write down a consistent vocabulary for warning flag names * We keep `-fwarn-` flags as they are currently * We keep the inconsistently named -W flags corresponding to these `-fwarn-` flags * We add consistently named `-W` flags alongside these * We set a timeline for deprecating the inconsistent forms (perhaps in three or four releases) -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/11583> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#11583: Make warning names more consistent -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: task | Status: new Priority: normal | Milestone: 8.2.1 Component: Compiler | Version: 7.10.3 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Description changed by bgamari: @@ -1,3 +1,5 @@ - Sven Panne points out that current warning naming conventions used in GHC - are rather inconsistent. Since we are moving away from `-fwarn-` to `-W` - it would be nice if we could also try to fix up the names themselves. + Sven Panne [[https://mail.haskell.org/pipermail/ghc- + devs/2016-February/011393.html|points out]] that current warning naming + conventions used in GHC are rather inconsistent. Since we are moving away + from `-fwarn-` to `-W` it would be nice if we could also try to fix up the + names themselves. New description: Sven Panne [[https://mail.haskell.org/pipermail/ghc- devs/2016-February/011393.html|points out]] that current warning naming conventions used in GHC are rather inconsistent. Since we are moving away from `-fwarn-` to `-W` it would be nice if we could also try to fix up the names themselves. We do, however, want to make sure that transition isn't more painful for users than necessary. For instance, the user should be able to get useful feedback from the compiler on what warning flags have changed with `s/-fwarn-/-W/` To this end I recommend the following, * We write down a consistent vocabulary for warning flag names * We keep `-fwarn-` flags as they are currently * We keep the inconsistently named -W flags corresponding to these `-fwarn-` flags * We add consistently named `-W` flags alongside these * We set a timeline for deprecating the inconsistent forms (perhaps in three or four releases) -- -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/11583#comment:1> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#11583: Make warning names more consistent -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: task | Status: new Priority: normal | Milestone: 8.2.1 Component: Compiler | Version: 7.10.3 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Changes (by heisenbug): * cc: heisenbug (added) -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/11583#comment:2> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#11583: Make warning names more consistent -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: task | Status: new Priority: normal | Milestone: 8.2.1 Component: Compiler | Version: 7.10.3 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Comment (by svenpanne): Hmmm, can we have a fix for this ''before'' the final 8.0.1 comes out? Otherwise things are a bit chaotic: We introduce the new -W form (and new warnings), only to have some of those -Wfoo renamed immediately afterwards, leading to even more CPP magic in projects. The short form of the changes, just for reference: * Use "sigs" or "signatures" consistently (doesn't really matter which one) * Use "pattern-synonyms", not "pat-syn" Currently e.g. the `half` package doesn't work with the GHC 8 series because of the ad-hoc naming changes of `-fno-warn-missing-pat-syn-sigs` (which is called `-Wno-missing-pat-syn-signatures` currently, but will be `-Wno-missing-pattern-synonym-signatures` or `-Wno-missing-pattern- synonym-sigs`, who knows...?). -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/11583#comment:3> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#11583: Make warning names more consistent -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: task | Status: new Priority: normal | Milestone: 8.2.1 Component: Compiler | Version: 7.10.3 Resolution: | Keywords: newcomer Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Changes (by thomie): * keywords: => newcomer Comment:
can we have a fix for this before the final 8.0.1 comes out
Seems like an suitable task for a newcomer. * The code is in `compiler/main/DynFlags.hs`. * Don't forget to update the documentation in the `docs/users_guide` and `utils/mkUserGuidePart` directory. * Submit your patch to [wiki:Phabricator]. -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/11583#comment:4> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#11583: Make warning names more consistent -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: task | Status: new Priority: high | Milestone: 8.0.1 Component: Compiler | Version: 7.10.3 Resolution: | Keywords: newcomer Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Changes (by svenpanne): * priority: normal => high * milestone: 8.2.1 => 8.0.1 Comment: Setting milestone to 8.0.1 and raising priority a bit, trying to avoid an upcoming compatibility nightmare for package maintainers... -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/11583#comment:5> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#11583: Make warning names more consistent -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: task | Status: new Priority: high | Milestone: 8.0.1 Component: Compiler | Version: 7.10.3 Resolution: | Keywords: newcomer Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D1939 Wiki Page: | -------------------------------------+------------------------------------- Changes (by manav): * differential: => Phab:D1939 -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/11583#comment:6> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#11583: Make warning names more consistent -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: task | Status: patch Priority: high | Milestone: 8.0.1 Component: Compiler | Version: 7.10.3 Resolution: | Keywords: newcomer Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D1939 Wiki Page: | -------------------------------------+------------------------------------- Changes (by bgamari): * status: new => patch -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/11583#comment:7> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#11583: Make warning names more consistent -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: task | Status: patch Priority: high | Milestone: 8.0.1 Component: Compiler | Version: 7.10.3 Resolution: | Keywords: newcomer Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D1939 Wiki Page: | -------------------------------------+------------------------------------- Comment (by Ben Gamari <ben@…>): In [changeset:"665849142bca36c14bcb25d64180c153a1ef1f2c/ghc" 6658491/ghc]: {{{ #!CommitTicketReference repository="ghc" revision="665849142bca36c14bcb25d64180c153a1ef1f2c" Make warning names more consistent - Replace "Sigs" with "Signatures" in WarningFlag data constructors. - Replace "PatSyn" with "PatternSynonym" in WarningFlag data constructors. - Deprecate "missing-local-sigs" in favor of "missing-local-signatures". - Deprecate "missing-exported-sigs" in favor of "missing-exported-signatures". - Deprecate "missing-pat-syn-signatures" in favor of "missing-pattern-synonym-signatures". - Replace "ddump-strsigs" with "ddump-str-signatures" These complete the tasks that were explicitly mentioned in #11583 Test Plan: Executed `ghc --show-options` and verified that the flags were changed as expected. Reviewers: svenpanne, austin, bgamari Reviewed By: austin, bgamari Subscribers: mpickering, thomie Differential Revision: https://phabricator.haskell.org/D1939 GHC Trac Issues: #11583 }}} -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/11583#comment:8> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#11583: Make warning names more consistent -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: task | Status: merge Priority: high | Milestone: 8.0.1 Component: Compiler | Version: 7.10.3 Resolution: | Keywords: newcomer Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D1939 Wiki Page: | -------------------------------------+------------------------------------- Changes (by bgamari): * status: patch => merge -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/11583#comment:9> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#11583: Make warning names more consistent -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: task | Status: closed Priority: high | Milestone: 8.0.1 Component: Compiler | Version: 7.10.3 Resolution: fixed | Keywords: newcomer Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D1939 Wiki Page: | -------------------------------------+------------------------------------- Changes (by bgamari): * status: merge => closed * resolution: => fixed Comment: Merged as e61e29081c8f73d3fa933f456fac49c51a9599db. -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/11583#comment:10> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
participants (1)
-
GHC