Opened 10 years ago

Closed 9 years ago

#1891 closed bug (fixed)

New RTS "--info" option not in help message

Reported by: Orphi Owned by: igloo
Priority: normal Milestone: 6.10 branch
Component: Runtime System Version: 6.8.1
Keywords: Cc:
Operating System: Windows Architecture: Unknown/Multiple
Type of failure: None/Unknown Test Case:
Blocked By: Blocking:
Related Tickets: Differential Rev(s):
Wiki Page:


The release notes mention a new RTS option --info, which prints out various information about any GHC-compiled program. (I don't actually see anywhere that explains what this data is ment to mean, although much of it is self-explanatory.)

When a program is invoked with the RTS option -?, it prints a list of all accepted RTS options. However, --info is not listed. Presumably this is just an oversight?

Attachments (1)

Fix1891 (149.7 KB) - added by Orphi 9 years ago.
Patch to GHC user guide.

Download all attachments as: .zip

Change History (7)

comment:1 Changed 10 years ago by igloo

difficulty: Unknown
Milestone: 6.8.2
Owner: set to igloo

Just an oversight; easy to fix for 6.8.2. Thanks for the report!

As for the meanings, yes, more documentation would be good. My primary goal was to get it into GHC ASAP, so that tools like Cabal can start relying on it being available sooner, and so we can start asking people to include its output in bug reports immediately, though.

comment:2 Changed 10 years ago by igloo

Milestone: branch
Owner: igloo deleted

I've added --info to the help message (HEAD and 6.8 branch). We should probably still document what the output means.

comment:3 Changed 9 years ago by igloo

Milestone: 6.8 branch6.10 branch

comment:4 Changed 9 years ago by Orphi

Owner: set to Orphi

Since you've already done the hard part, I'll take a stab at writing the documentation myself and submitting a patch for it. (If I can figure out how... never done this before!)

I've managed to find out a lot from the GHC commentary. I have a couple of questions remaining:

  • Can "GHC RTS" ever be "no"? How?
  • Does anybody have a list of the possible RTS "ways"?


Changed 9 years ago by Orphi

Attachment: Fix1891 added

Patch to GHC user guide.

comment:5 Changed 9 years ago by Orphi

Architecture: x86Unknown/Multiple
Owner: changed from Orphi to igloo

OK, hopefully I did this right. I've made a patch against the user guide for GHC HEAD. Somebody should probably check that:

  • My DocBook markup isn't bogus. (I've never heard of DocBook before, but my additions appear to compile to HTML without issue.)
  • The information I've added is actually correct. (I took a guess at the RTS ways, based on experimental testing and comments in the various makefiles, header files and C bits.)


comment:6 Changed 9 years ago by igloo

Resolution: fixed
Status: newclosed

Thanks for the patch! I've applied it to HEAD and 6.10.

"GHC RTS" is always "YES". It's partly because being sure you're looking at what you think you're looking at is useful, and partly because it makes the code simpler (all the other lines start ,( but that one starts [( so it's simpler to make it a hardcoded string than to generalise the code for printing lines).

Note: See TracTickets for help on using tickets.