Some GHCi options are undocumented

The following commands are missing from the list found in GHCi documentation:

:check, :issafe, :showi, :list, :steplocal, :stepmodule

At least last three are documented in debugger documentation, but a link would be nice.

Trac metadata

Trac field	Value
Version	7.6.1
Type	Bug
TypeOfFailure	OtherFailure
Priority	normal
Resolution	Unresolved
Component	Compiler
Test case
Differential revisions
BlockedBy
Related
Blocking
CC
Operating system
Architecture

changed weight to 5

added Tbug Trac import labels

Trac metadata

Trac field	Value
Component	Compiler → Documentation

check was added in:

commit 79d6745f66c678de5e104b2146d3dd3e2f006c3e
Author: Simon Marlow <marlowsd@gmail.com>
Date:   Fri Aug 26 16:36:05 2011 +0100

    Clean up the handling of the import and :module commands in GHCi

Simon did add documentation for some of the other options he added, so either he intended it to be internal or forgot to remove it? It prints out the global and local names of a module, but it only works on interpreted modules.

issafe was added in:

commit e0eb7e7de292ba2bb0aa5ca261b7b41169b58af0
Author: David Terei <davidterei@gmail.com>
Date:   Tue May 17 01:19:23 2011 -0700

    SafeHaskell: Add ':issafe' cmd to GHCi that displays module safety info

Definitely ought to be documented.

showi was added in:

commit 2e55760b856540535fa0e4fe1805a75eea7d6b45
Author: Simon Marlow <marlowsd@gmail.com>
Date:   Wed Feb 29 16:23:08 2012 +0000

    GHCi: add :seti, for options that apply only at the prompt (#3217)

Probably should be documented, although currently since it only accepts 'language' it is completely subsumed by ':seti' with no arguments.

Patches welcome!

:check has been around for a long time (I traced it back to 2005), I think it is only for debugging, and we don't want to document it.

I'll add docs for :showi, I think that was an oversight.

mentioned in commit f838d2f3

changed milestone to %7.8.1

changed weight to 7

Let's get this done before 7.8.1.

Trac metadata

Trac field	Value
Priority	normal → high

To be clear, the following commands still need documentation,

• :issafe
• :list
• :steplocal
• :stepmodule

assigned to @bgamari

I'll be working on this in my ghci-docs branch https://github.com/bgamari/ghc/compare/ghci-docs

changed title from Some GHCi options are undocummented to Some GHCi options are undocumented

mentioned in commit efb9e829

mentioned in commit ea2af9b2

closed

Applied, thanks!

Trac metadata

Trac field	Value
Resolution	Unresolved → ResolvedFixed

added Phigh label

marked this issue as related to #24509 (closed)