[GHC] #8190: mention --show-options in --help

#8190: mention --show-options in --help ------------------------------------+------------------------------------- Reporter: carter | Owner: Type: feature request | Status: new Priority: normal | Milestone: Component: Compiler | Version: 7.7 Keywords: | Operating System: Unknown/Multiple Architecture: Unknown/Multiple | Type of failure: None/Unknown Difficulty: Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | ------------------------------------+------------------------------------- GHC head now has a --show-options flag, that lists all of the supported ghc options. maybe --help should mention this flag, and that every option is specified in the ghc manual? -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8190 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#8190: mention --show-options in --help -------------------------------------+------------------------------------ Reporter: carter | Owner: thoughtpolice Type: feature request | Status: new Priority: highest | Milestone: _|_ Component: Compiler | Version: 7.7 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Unknown/Multiple Type of failure: None/Unknown | Difficulty: Unknown Test Case: | Blocked By: Blocking: | Related Tickets: -------------------------------------+------------------------------------ Changes (by simonpj): * owner: => thoughtpolice * priority: normal => highest * milestone: => _|_ -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8190#comment:1 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#8190: mention --show-options in --help -------------------------------------+------------------------------------ Reporter: carter | Owner: thoughtpolice Type: feature request | Status: new Priority: highest | Milestone: 7.8.1 Component: Compiler | Version: 7.7 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Unknown/Multiple Type of failure: None/Unknown | Difficulty: Unknown Test Case: | Blocked By: Blocking: | Related Tickets: -------------------------------------+------------------------------------ Changes (by simonpj): * milestone: _|_ => 7.8.1 -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8190#comment:2 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#8190: mention --show-options in --help -------------------------------------+------------------------------------ Reporter: carter | Owner: thoughtpolice Type: feature request | Status: new Priority: highest | Milestone: 7.8.1 Component: Compiler | Version: 7.7 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Unknown/Multiple Type of failure: None/Unknown | Difficulty: Unknown Test Case: | Blocked By: Blocking: | Related Tickets: #7843 -------------------------------------+------------------------------------ Changes (by jstolarek): * related: => #7843 Comment: I'm not convinced that we should do this. `--show-options` currently displays 743 flags - will this enormous list be helpful for a person that's trying to get a flag right? Other than that, `--show-options` is documented in user manual. But this brought my attention to another issue with the help message. We are mentioning `-fglasgow-exts` flag in the help message, but that flag actually is deprecated and generates a warning. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8190#comment:3 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#8190: mention --show-options in --help -------------------------------------+------------------------------------ Reporter: carter | Owner: thoughtpolice Type: feature request | Status: new Priority: highest | Milestone: 7.8.1 Component: Compiler | Version: 7.7 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Unknown/Multiple Type of failure: None/Unknown | Difficulty: Unknown Test Case: | Blocked By: Blocking: | Related Tickets: #7843 -------------------------------------+------------------------------------ Changes (by jstolarek): * cc: jan.stolarek@… (added) -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8190#comment:4 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#8190: mention --show-options in --help -------------------------------------+------------------------------------ Reporter: carter | Owner: thoughtpolice Type: feature request | Status: new Priority: highest | Milestone: 7.8.1 Component: Compiler | Version: 7.7 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Unknown/Multiple Type of failure: None/Unknown | Difficulty: Unknown Test Case: | Blocked By: Blocking: | Related Tickets: #7843 -------------------------------------+------------------------------------ Comment (by carter): @jan, on one hand you're right. On the other hand, most other compilers (eg clang and gcc) do have a way of listing all of the documented options, or at least most of them. however, Theres definitely value in having a curated list of all the stable flags when someone does {{{ ghc -h or ghc --help }}} which we currently only do i the barest minimal sense possible -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8190#comment:5 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#8190: mention --show-options in --help -------------------------------------+------------------------------------ Reporter: carter | Owner: thoughtpolice Type: feature request | Status: new Priority: highest | Milestone: 7.8.1 Component: Compiler | Version: 7.7 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Unknown/Multiple Type of failure: None/Unknown | Difficulty: Unknown Test Case: | Blocked By: Blocking: | Related Tickets: #7843 -------------------------------------+------------------------------------ Comment (by jstolarek): I have no strong reasons to object. I'm just not sure if this is the most important info that should be mentioned by `--help`, but I guess it won't do any harm. Replying to [comment:5 carter]:
listing all of the documented options Just to be clear - `--show-options` lists all options, whether documented or not :) Do we have any options that we would like to keep hidden from users?
-- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8190#comment:6 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#8190: mention --show-options in --help -------------------------------------+------------------------------------ Reporter: carter | Owner: thoughtpolice Type: feature request | Status: new Priority: highest | Milestone: 7.8.1 Component: Compiler | Version: 7.7 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Unknown/Multiple Type of failure: None/Unknown | Difficulty: Unknown Test Case: | Blocked By: Blocking: | Related Tickets: #7843 -------------------------------------+------------------------------------ Comment (by nh2): As somebody who messes around with tools calling GHC, I would appreciate this option. It would also make it much easier to find options that are not documented! -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8190#comment:7 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#8190: mention --show-options in --help -------------------------------------+------------------------------------ Reporter: carter | Owner: thoughtpolice Type: feature request | Status: new Priority: highest | Milestone: 7.8.1 Component: Compiler | Version: 7.7 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Unknown/Multiple Type of failure: None/Unknown | Difficulty: Unknown Test Case: | Blocked By: Blocking: | Related Tickets: #7843 -------------------------------------+------------------------------------ Comment (by carter): I also just learned today that ghc has a man page! we should have that mentioned in the help text too probably! -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8190#comment:8 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#8190: mention --show-options in --help
-------------------------------------+------------------------------------
Reporter: carter | Owner: thoughtpolice
Type: feature request | Status: new
Priority: highest | Milestone: 7.8.1
Component: Compiler | Version: 7.7
Resolution: | Keywords:
Operating System: Unknown/Multiple | Architecture: Unknown/Multiple
Type of failure: None/Unknown | Difficulty: Unknown
Test Case: | Blocked By:
Blocking: | Related Tickets: #7843
-------------------------------------+------------------------------------
Comment (by Austin Seipp

#8190: mention --show-options in --help -------------------------------------+------------------------------------ Reporter: carter | Owner: thoughtpolice Type: feature request | Status: closed Priority: highest | Milestone: 7.8.1 Component: Compiler | Version: 7.7 Resolution: fixed | Keywords: Operating System: Unknown/Multiple | Architecture: Unknown/Multiple Type of failure: None/Unknown | Difficulty: Unknown Test Case: | Blocked By: Blocking: | Related Tickets: #7843 -------------------------------------+------------------------------------ Changes (by thoughtpolice): * status: new => closed * resolution: => fixed Comment: The man page is auto-generated and already has `--show-options`. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8190#comment:10 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
participants (1)
-
GHC