[GHC] #10917: Provide a utility to check API Annotations
#10917: Provide a utility to check API Annotations -------------------------------------+------------------------------------- Reporter: alanz | Owner: alanz Type: bug | Status: new Priority: normal | Milestone: 8.0.1 Component: Compiler | Version: 7.10.2 Keywords: | Operating System: Unknown/Multiple ApiAnnotations | Architecture: | Type of failure: None/Unknown Unknown/Multiple | Test Case: | Blocked By: Blocking: | Related Tickets: Differential Rev(s): | -------------------------------------+------------------------------------- At the moment it is difficult for GHC developers to know if they have broken the API Annotations. Provide a utility that can be used as a test to show up errors in the API Annotations. This is to be based on the current tests for ghc-api/annotations which can parse a file using the just-built GHC API, and check that no annotations are disconnected from the ParsedSource in the output. In addition, it should be able to dump the annotations to a file, so a new feature developer can check that all changes to the parser do provide annotations. -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10917> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#10917: Provide a utility to check API Annotations -------------------------------------+------------------------------------- Reporter: alanz | Owner: alanz Type: bug | Status: new Priority: normal | Milestone: 8.0.1 Component: Compiler | Version: 7.10.2 Resolution: | Keywords: | ApiAnnotations Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D1368 Wiki Page: | -------------------------------------+------------------------------------- Changes (by alanz): * differential: => Phab:D1368 -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10917#comment:1> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#10917: Provide a utility to check API Annotations -------------------------------------+------------------------------------- Reporter: alanz | Owner: alanz Type: bug | Status: patch Priority: normal | Milestone: 8.0.1 Component: Compiler | Version: 7.10.2 Resolution: | Keywords: | ApiAnnotations Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D1368 Wiki Page: | -------------------------------------+------------------------------------- Changes (by alanz): * status: new => patch -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10917#comment:2> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#10917: Provide a utility to check API Annotations -------------------------------------+------------------------------------- Reporter: alanz | Owner: alanz Type: bug | Status: patch Priority: normal | Milestone: 8.0.1 Component: Compiler | Version: 7.10.2 Resolution: | Keywords: | ApiAnnotations Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D1368 Wiki Page: | -------------------------------------+------------------------------------- Comment (by Ben Gamari <ben@…>): In [changeset:"43751b2436f370d956d8021b3cdd3eb77801470b/ghc" 43751b2/ghc]: {{{ #!CommitTicketReference repository="ghc" revision="43751b2436f370d956d8021b3cdd3eb77801470b" Provide a utility to check API Annotations It is difficult for GHC developers to know if they have broken the API Annotations. This patch provides a utility that can be used as a test to show up errors in the API Annotations. It is based on the current tests for ghc-api/annotations which can parse a file using the just-built GHC API, and check that no annotations are disconnected from the ParsedSource in the output. In addition, it should be able to dump the annotations to a file, so a new feature developer can check that all changes to the parser do provide annotations. Trac ticket: #10917 Test Plan: ./validate Reviewers: hvr, thomie, austin, bgamari Reviewed By: bgamari Differential Revision: https://phabricator.haskell.org/D1368 GHC Trac Issues: #10917 }}} -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10917#comment:3> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#10917: Provide a utility to check API Annotations -------------------------------------+------------------------------------- Reporter: alanz | Owner: Type: bug | Status: new Priority: normal | Milestone: 8.0.1 Component: Compiler | Version: 7.10.2 Resolution: | Keywords: | ApiAnnotations Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D1368 Wiki Page: | -------------------------------------+------------------------------------- Changes (by alanz): * owner: alanz => * status: patch => new -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10917#comment:4> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#10917: Provide a utility to check API Annotations -------------------------------------+------------------------------------- Reporter: alanz | Owner: alanz Type: bug | Status: new Priority: normal | Milestone: 8.0.1 Component: Compiler | Version: 7.10.2 Resolution: | Keywords: | ApiAnnotations Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D1368 Wiki Page: | -------------------------------------+------------------------------------- Changes (by alanz): * owner: => alanz Comment: Although the patch has landed in master, I still need to write a proper manual for it, and clean up the output so it is more understandable. -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10917#comment:5> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#10917: Provide a utility to check API Annotations -------------------------------------+------------------------------------- Reporter: alanz | Owner: alanz Type: bug | Status: new Priority: normal | Milestone: 8.0.1 Component: Compiler | Version: 7.10.2 Resolution: | Keywords: | ApiAnnotations Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | Phab:D1368,Phab:D1397 -------------------------------------+------------------------------------- Changes (by alanz): * differential: Phab:D1368 => Phab:D1368,Phab:D1397 -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10917#comment:6> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#10917: Provide a utility to check API Annotations -------------------------------------+------------------------------------- Reporter: alanz | Owner: alanz Type: bug | Status: patch Priority: normal | Milestone: 8.0.1 Component: Compiler | Version: 7.10.2 Resolution: | Keywords: | ApiAnnotations Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D1368 Wiki Page: | Phab:D1397 -------------------------------------+------------------------------------- Changes (by alanz): * status: new => patch * differential: Phab:D1368,Phab:D1397 => Phab:D1368 Phab:D1397 -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10917#comment:7> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#10917: Provide a utility to check API Annotations -------------------------------------+------------------------------------- Reporter: alanz | Owner: alanz Type: bug | Status: patch Priority: normal | Milestone: 8.0.1 Component: Compiler | Version: 7.10.2 Resolution: | Keywords: | ApiAnnotations Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D1368 Wiki Page: | Phab:D1397 -------------------------------------+------------------------------------- Comment (by Ben Gamari <ben@…>): In [changeset:"c3b02150b516963422ed4b9b200a38814a35b535/ghc" c3b02150/ghc]: {{{ #!CommitTicketReference repository="ghc" revision="c3b02150b516963422ed4b9b200a38814a35b535" Provide a utility to check API Annotations docs A utility to check API Annotations was provided in https://git.haskell.org/ghc.git/commitdiff/43751b2436f370d956d8021b3cdd3 eb77801470b This commit had poor documentation. This patch improves the output generated by the utility as well as supplying better documentation Test Plan: ./validate Reviewers: simonpj, austin, bgamari Reviewed By: austin, bgamari Subscribers: thomie, mpickering Differential Revision: https://phabricator.haskell.org/D1397 GHC Trac Issues: #10917 }}} -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10917#comment:8> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#10917: Provide a utility to check API Annotations -------------------------------------+------------------------------------- Reporter: alanz | Owner: alanz Type: bug | Status: closed Priority: normal | Milestone: 8.0.1 Component: Compiler | Version: 7.10.2 Resolution: fixed | Keywords: | ApiAnnotations Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D1368 Wiki Page: | Phab:D1397 -------------------------------------+------------------------------------- Changes (by bgamari): * status: patch => closed * resolution: => fixed -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10917#comment:9> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
participants (1)
-
GHC