[GHC] #14229: Contraditions in users_guide/using-warnings.html

#14229: Contraditions in users_guide/using-warnings.html -------------------------------------+------------------------------------- Reporter: | Owner: (none) MikolajKonarski | Type: bug | Status: new Priority: low | Milestone: Component: Documentation | Version: 8.2.1 Keywords: | Operating System: Unknown/Multiple Architecture: | Type of failure: Documentation Unknown/Multiple | bug Test Case: | Blocked By: Blocking: | Related Tickets: Differential Rev(s): | Wiki Page: -------------------------------------+------------------------------------- Lists are not updated in https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/using- warnings.html E.g., it says "The warnings that are not enabled by -Wall are ...-Wredundant-constraints", but then it says "This option is on by default". Also "-Worphans" is on none of the list of enabled or not enabled flags and also there is no mention in its description if its enabled by default or not. I guess there may be more. Also, it may be worth mentioning that obsolete warnings or warnings subsumed by others are not on any of the list, or whatever the actual rule is. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/14229 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#14229: Contraditions in users_guide/using-warnings.html -------------------------------------+------------------------------------- Reporter: MikolajKonarski | Owner: (none) Type: bug | Status: new Priority: low | Milestone: Component: Documentation | Version: 8.2.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Comment (by bgamari): Oh dear; yes, it was only a matter of time until this fell out of sync. I'm a bit on the fence regarding whether we should invest some effort into automating the documentation generation or just fix it this once and try to be more careful in the future. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/14229#comment:1 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#14229: Contraditions in users_guide/using-warnings.html -------------------------------------+------------------------------------- Reporter: MikolajKonarski | Owner: (none) Type: bug | Status: new Priority: low | Milestone: Component: Documentation | Version: 8.2.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Comment (by MikolajKonarski): That's actually an easy, nice, introductory ticket for would-be GHC- contributors, so why waste computing power, when humans can do it almost as well. :) We'd just need to post it once a major release on a page with intro tickets and perhaps advertise the page on some hacker forums. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/14229#comment:2 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#14229: Contraditions in users_guide/using-warnings.html -------------------------------------+------------------------------------- Reporter: MikolajKonarski | Owner: (none) Type: bug | Status: new Priority: low | Milestone: Component: Documentation | Version: 8.2.1 Resolution: | Keywords: newcomers Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Changes (by bgamari): * keywords: => newcomers Comment: Indeed we have the `newcomers` tag for precisely this reason. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/14229#comment:3 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#14229: Contraditions in users_guide/using-warnings.html -------------------------------------+------------------------------------- Reporter: MikolajKonarski | Owner: (none) Type: bug | Status: new Priority: low | Milestone: Component: Documentation | Version: 8.2.1 Resolution: | Keywords: newcomers Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Comment (by voanhduy1512): Hello, I am new to Haskell (never use in prod) and ghc but i think i can help. I need to follow this process https://ghc.haskell.org/trac/ghc/wiki/WorkingConventions/DocumentationChange... to update the document right? -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/14229#comment:4 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#14229: Contraditions in users_guide/using-warnings.html -------------------------------------+------------------------------------- Reporter: MikolajKonarski | Owner: voanhduy1512 Type: bug | Status: new Priority: low | Milestone: Component: Documentation | Version: 8.2.1 Resolution: | Keywords: newcomers Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D4528 Wiki Page: | -------------------------------------+------------------------------------- Changes (by voanhduy1512): * owner: (none) => voanhduy1512 * differential: => Phab:D4528 -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/14229#comment:5 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#14229: Contraditions in users_guide/using-warnings.html
-------------------------------------+-------------------------------------
Reporter: MikolajKonarski | Owner: voanhduy1512
Type: bug | Status: new
Priority: low | Milestone:
Component: Documentation | Version: 8.2.1
Resolution: | Keywords: newcomers
Operating System: Unknown/Multiple | Architecture:
Type of failure: Documentation | Unknown/Multiple
bug | Test Case:
Blocked By: | Blocking:
Related Tickets: | Differential Rev(s): Phab:D4528
Wiki Page: |
-------------------------------------+-------------------------------------
Comment (by Ben Gamari

#14229: Contraditions in users_guide/using-warnings.html -------------------------------------+------------------------------------- Reporter: MikolajKonarski | Owner: voanhduy1512 Type: bug | Status: new Priority: low | Milestone: Component: Documentation | Version: 8.2.1 Resolution: | Keywords: newcomers Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D4528 Wiki Page: | -------------------------------------+------------------------------------- Comment (by bgamari): Thanks voanhduy1512! Have you checked whether any of the other issues brought up in this ticket still need fixing? -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/14229#comment:7 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#14229: Contraditions in users_guide/using-warnings.html -------------------------------------+------------------------------------- Reporter: MikolajKonarski | Owner: voanhduy1512 Type: bug | Status: new Priority: low | Milestone: Component: Documentation | Version: 8.2.1 Resolution: | Keywords: newcomers Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D4528 Wiki Page: | -------------------------------------+------------------------------------- Comment (by voanhduy1512): Replying to [comment:7 bgamari]:
Thanks voanhduy1512! Have you checked whether any of the other issues brought up in this ticket still need fixing?
I think there are other missing doc, likes no mentions about `deferred- type-errors`, `type-holes` ... I will send another patch to address all missing pieces that i can identify. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/14229#comment:8 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#14229: Contraditions in users_guide/using-warnings.html -------------------------------------+------------------------------------- Reporter: MikolajKonarski | Owner: voanhduy1512 Type: bug | Status: new Priority: low | Milestone: Component: Documentation | Version: 8.2.1 Resolution: | Keywords: newcomers Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D4528 Wiki Page: | -------------------------------------+------------------------------------- Comment (by bgamari): Thanks again for picking this up! -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/14229#comment:9 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#14229: Contraditions in users_guide/using-warnings.html -------------------------------------+------------------------------------- Reporter: MikolajKonarski | Owner: voanhduy1512 Type: bug | Status: new Priority: low | Milestone: Component: Documentation | Version: 8.2.1 Resolution: | Keywords: newcomers Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D4528 Wiki Page: | -------------------------------------+------------------------------------- Comment (by MikolajKonarski): Indeed, thank you, voanhduy1512. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/14229#comment:10 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#14229: Contraditions in users_guide/using-warnings.html -------------------------------------+------------------------------------- Reporter: MikolajKonarski | Owner: voanhduy1512 Type: bug | Status: new Priority: low | Milestone: Component: Documentation | Version: 8.2.1 Resolution: | Keywords: newcomers Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D4528 Wiki Page: | -------------------------------------+------------------------------------- Comment (by voanhduy1512): Replying to [comment:9 bgamari]:
Thanks again for picking this up! Replying to [comment:10 MikolajKonarski]: Indeed, thank you, voanhduy1512.
You are welcome. I have one more question: currently `-Wall` written in the form that's list warning that are not enable. But the code itself actually is `-W` plus few more warnings. So with more warning add to ghc, the doc will be very easy to be incorrect. Should we can the doc for -Wall to say what it included instead of excluded? -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/14229#comment:11 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#14229: Contraditions in users_guide/using-warnings.html -------------------------------------+------------------------------------- Reporter: MikolajKonarski | Owner: voanhduy1512 Type: bug | Status: new Priority: low | Milestone: Component: Documentation | Version: 8.2.1 Resolution: | Keywords: newcomers Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D4528 Wiki Page: | -------------------------------------+------------------------------------- Comment (by MikolajKonarski): I'm not sure, because many of the new warnings are added with the intention of adding them to -Wall sooner or later, so the positive list would need to grow, too. Also, the list of warnings included in -Wall is much longer than the list of warnings excluded. An option is to provide both lists and remark that if a warning is on neither list, it must be a new one and please file a Trac ticket. Then we are at least not stating a falsehood. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/14229#comment:12 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#14229: Contraditions in users_guide/using-warnings.html -------------------------------------+------------------------------------- Reporter: MikolajKonarski | Owner: voanhduy1512 Type: bug | Status: new Priority: low | Milestone: Component: Documentation | Version: 8.2.1 Resolution: | Keywords: newcomers Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D4528, Wiki Page: | Phab:D4562 -------------------------------------+------------------------------------- Changes (by voanhduy1512): * differential: Phab:D4528 => Phab:D4528, Phab:D4562 -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/14229#comment:13 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#14229: Contraditions in users_guide/using-warnings.html -------------------------------------+------------------------------------- Reporter: MikolajKonarski | Owner: voanhduy1512 Type: bug | Status: new Priority: low | Milestone: Component: Documentation | Version: 8.2.1 Resolution: | Keywords: newcomers Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D4528, Wiki Page: | Phab:D4562 -------------------------------------+------------------------------------- Comment (by voanhduy1512): Replying to [comment:12 MikolajKonarski]:
I'm not sure, because many of the new warnings are added with the intention of adding them to -Wall sooner or later, so the positive list would need to grow, too. Also, the list of warnings included in -Wall is much longer than the list of warnings excluded. An option is to provide both lists and remark that if a warning is on neither list, it must be a new one and please file a Trac ticket. Then we are at least not stating a falsehood.
I try to build a list status of options here https://gist.github.com/voanhduy1512/7769e04b925069170212400b57f5d4a3. Right now there is more options which excluded in `-Wall` than included. Maybe it will be change in future but i think it's easier to add positive list. For example i add a option to `-Wall` but forgot to update the doc, it's easy to update the doc to correct state just by looking at the code. As for current state, i need to get all options, minus all default options, minus all `-W`, `-Wall`, to get the real list that are not in `-Wall`. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/14229#comment:14 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#14229: Contraditions in users_guide/using-warnings.html -------------------------------------+------------------------------------- Reporter: MikolajKonarski | Owner: voanhduy1512 Type: bug | Status: new Priority: low | Milestone: Component: Documentation | Version: 8.2.1 Resolution: | Keywords: newcomers Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D4528, Wiki Page: | Phab:D4562 -------------------------------------+------------------------------------- Comment (by MikolajKonarski): Wow, great job. You are right, I had in mind the total number of warnings included by `-Wall`, but we list them separately for `on`, `-W` and `-Wall` and that's indeed the best way. I like your idea to provide a positive list for `-Wall`, as is the case for the other groups. Ben, what do you think? -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/14229#comment:15 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#14229: Contraditions in users_guide/using-warnings.html -------------------------------------+------------------------------------- Reporter: MikolajKonarski | Owner: voanhduy1512 Type: bug | Status: new Priority: low | Milestone: Component: Documentation | Version: 8.2.1 Resolution: | Keywords: newcomers Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D4528, Wiki Page: | Phab:D4562 -------------------------------------+------------------------------------- Comment (by MikolajKonarski): There is a new comment Phab (I know there were problems with notification emails recently): https://phabricator.haskell.org/D4562#128940 -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/14229#comment:16 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#14229: Contraditions in users_guide/using-warnings.html -------------------------------------+------------------------------------- Reporter: MikolajKonarski | Owner: voanhduy1512 Type: bug | Status: new Priority: low | Milestone: Component: Documentation | Version: 8.2.1 Resolution: | Keywords: newcomer Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D4528, Wiki Page: | Phab:D4562 -------------------------------------+------------------------------------- Changes (by monoidal): * keywords: newcomers => newcomer -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/14229#comment:17 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
participants (1)
-
GHC