[GHC] #15773: User Guide contains erroneous information about `-rtsopts` modes.

GHC ghc-devs at haskell.org
Thu Oct 18 12:39:47 UTC 2018


#15773: User Guide contains erroneous information about `-rtsopts` modes.
-------------------------------------+-------------------------------------
        Reporter:  _recursion        |                Owner:  (none)
            Type:  task              |               Status:  new
        Priority:  normal            |            Milestone:
       Component:  Documentation     |              Version:
      Resolution:                    |             Keywords:  User Guide
Operating System:  Unknown/Multiple  |         Architecture:
 Type of failure:  Documentation     |  Unknown/Multiple
  bug                                |            Test Case:
      Blocked By:                    |             Blocking:
 Related Tickets:                    |  Differential Rev(s):
       Wiki Page:                    |
-------------------------------------+-------------------------------------
Description changed by _recursion:

Old description:

> Currently the user guide section on
> [https://downloads.haskell.org/%7Eghc/latest/docs/html/users_guide/phases.html
> #ghc-flag--rtsopts[=%E2%9F%A8none|some|all|ignore|ignoreAll%E2%9F%A9
> `-rtsopts`] specifies that `-rtsopts=some` is the default setting in the
> text under it, while the specified default is `all`.
>
> Happy to submit a patch if someone can confirm that `all` is actually the
> default, and that I'm not misunderstanding the meaning here.

New description:

 Currently the user guide section on
 [https://downloads.haskell.org/%7Eghc/latest/docs/html/users_guide/phases.html
 #ghc-flag--rtsopts[=%E2%9F%A8none|some|all|ignore|ignoreAll%E2%9F%A9
 `-rtsopts`] specifies that `-rtsopts=some` is the default setting in the
 text under it, while the specified default is `all`.

 > "[this is the default setting] Enable only the “safe” RTS options:
 (Currently only `-?` and `--info`.) Any other RTS options on the command
 line or in the `GHCRTS` environment variable causes the program with to
 abort with an error message."

 Happy to submit a patch if someone can confirm that `all` is actually the
 default, and that I'm not misunderstanding the meaning here.

--

-- 
Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/15773#comment:1>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler


More information about the ghc-tickets mailing list