-<Sect1 id="options-debugging">
-<Title>Debugging the compiler
-</Title>
-
-<Para>
-<IndexTerm><Primary>debugging options (for GHC)</Primary></IndexTerm>
-</Para>
-
-<Para>
-HACKER TERRITORY. HACKER TERRITORY.
-(You were warned.)
-</Para>
-
-<Sect2 id="replacing-phases">
-<Title>Replacing the program for one or more phases.
-</Title>
-
-<Para>
-<IndexTerm><Primary>GHC phases, changing</Primary></IndexTerm>
-<IndexTerm><Primary>phases, changing GHC</Primary></IndexTerm>
-You may specify that a different program be used for one of the phases
-of the compilation system, in place of whatever the driver <Command>ghc</Command> has
-wired into it. For example, you might want to try a different
-assembler. The
-<Option>-pgm<phase-code><program-name></Option><IndexTerm><Primary>-pgm<phase><stuff>
-option</Primary></IndexTerm> option to <Command>ghc</Command> will cause it to use <Literal><program-name></Literal>
-for phase <Literal><phase-code></Literal>, where the codes to indicate the phases are:
-</Para>
-
-<Para>
-<InformalTable>
-<TGroup Cols="2">
-<ColSpec Align="Left" Colsep="0">
-<ColSpec Align="Left" Colsep="0">
-<TBody>
-<Row>
-<Entry><Emphasis>code</Emphasis> </Entry>
-<Entry><Emphasis>phase</Emphasis> </Entry>
-</Row>
-
-<Row>
-<Entry>
-L </Entry>
-<Entry> literate pre-processor </Entry>
-</Row>
-<Row>
-<Entry>
-P </Entry>
-<Entry> C pre-processor (if -cpp only) </Entry>
-</Row>
-<Row>
-<Entry>
-C </Entry>
-<Entry> Haskell compiler </Entry>
-</Row>
-<Row>
-<Entry>
-c </Entry>
-<Entry> C compiler</Entry>
-</Row>
-<Row>
-<Entry>
-a </Entry>
-<Entry> assembler </Entry>
-</Row>
-<Row>
-<Entry>
-l </Entry>
-<Entry> linker </Entry>
-</Row>
-<Row>
-<Entry>
-dep </Entry>
-<Entry> Makefile dependency generator </Entry>
-</Row>
-
-</TBody>
-
-</TGroup>
-</InformalTable>
-</Para>
-
-</Sect2>
-
-<Sect2 id="forcing-options-through">
-<Title>Forcing options to a particular phase.
-</Title>
-
-<Para>
-<IndexTerm><Primary>forcing GHC-phase options</Primary></IndexTerm>
-</Para>
-
-<Para>
-The preceding sections describe driver options that are mostly
-applicable to one particular phase. You may also <Emphasis>force</Emphasis> a
-specific option <Option><option></Option> to be passed to a particular phase
-<Literal><phase-code></Literal> by feeding the driver the option
-<Option>-opt<phase-code><option></Option>.<IndexTerm><Primary>-opt<phase><stuff>
-option</Primary></IndexTerm> The codes to indicate the phases are the same as in the
-previous section.
-</Para>
-
-<Para>
-So, for example, to force an <Option>-Ewurble</Option> option to the assembler, you
-would tell the driver <Option>-opta-Ewurble</Option> (the dash before the E is
-required).
-</Para>
-
-<Para>
-Besides getting options to the Haskell compiler with <Option>-optC<blah></Option>,
-you can get options through to its runtime system with
-<Option>-optCrts<blah></Option><IndexTerm><Primary>-optCrts<blah> option</Primary></IndexTerm>.
-</Para>
-
-<Para>
-So, for example: when I want to use my normal driver but with my
-profiled compiler binary, I use this script:
-
-<ProgramListing>
-#! /bin/sh
-exec /local/grasp_tmp3/simonpj/ghc-BUILDS/working-alpha/ghc/driver/ghc \
- -pgmC/local/grasp_tmp3/simonpj/ghc-BUILDS/working-hsc-prof/hsc \
- -optCrts-i0.5 \
- -optCrts-PT \
- "$@"
-</ProgramListing>
-
-</Para>
-
-</Sect2>
-
-<Sect2 id="dumping-output">
-<Title>Dumping out compiler intermediate structures
-</Title>
-
-<Para>
-<IndexTerm><Primary>dumping GHC intermediates</Primary></IndexTerm>
-<IndexTerm><Primary>intermediate passes, output</Primary></IndexTerm>
-</Para>
-
-<Para>
-<VariableList>
-
-<VarListEntry>
-<Term><Option>-noC</Option>:</Term>
-<ListItem>
-<Para>
-<IndexTerm><Primary>-noC option</Primary></IndexTerm>
-Don't bother generating C output <Emphasis>or</Emphasis> an interface file. Usually
-used in conjunction with one or more of the <Option>-ddump-*</Option> options; for
-example: <Command>ghc -noC -ddump-simpl Foo.hs</Command>
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-hi</Option>:</Term>
-<ListItem>
-<Para>
-<IndexTerm><Primary>-hi option</Primary></IndexTerm>
-<Emphasis>Do</Emphasis> generate an interface file. This would normally be used in
-conjunction with <Option>-noC</Option>, which turns off interface generation;
-thus: <Option>-noC -hi</Option>.
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-dshow-passes</Option>:</Term>
-<ListItem>
-<Para>
-<IndexTerm><Primary>-dshow-passes option</Primary></IndexTerm>
-Prints a message to stderr as each pass starts. Gives a warm but
-undoubtedly misleading feeling that GHC is telling you what's
-happening.
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-ddump-<pass></Option>:</Term>
-<ListItem>
-<Para>
-<IndexTerm><Primary>-ddump-<pass> options</Primary></IndexTerm>
-Make a debugging dump after pass <Literal><pass></Literal> (may be common enough to
-need a short form…). You can get all of these at once (<Emphasis>lots</Emphasis> of
-output) by using <Option>-ddump-all</Option>, or most of them with <Option>-ddump-most</Option>.
-Some of the most useful ones are:
-</Para>
-
-<Para>
-<VariableList>
-
-<VarListEntry>
-<Term><Option>-ddump-parsed</Option>:</Term>
-<ListItem>
-<Para>
-oarser output
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-ddump-rn</Option>:</Term>
-<ListItem>
-<Para>
-renamer output
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-ddump-tc</Option>:</Term>
-<ListItem>
-<Para>
-typechecker output
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-ddump-deriv</Option>:</Term>
-<ListItem>
-<Para>
-derived instances
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-ddump-ds</Option>:</Term>
-<ListItem>
-<Para>
-desugarer output
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-ddump-spec</Option>:</Term>
-<ListItem>
-<Para>
-output of specialisation pass
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-ddump-rules</Option>:</Term>
-<ListItem>
-<Para>
-dumps all rewrite rules (including those generated by the specialisation pass)
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-ddump-simpl</Option>:</Term>
-<ListItem>
-<Para>
-simplifer output (Core-to-Core passes)
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-ddump-usagesp</Option>:</Term>
-<ListItem>
-<Para>
-UsageSP inference pre-inf and output
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-ddump-cpranal</Option>:</Term>
-<ListItem>
-<Para>
-CPR analyser output
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-ddump-stranal</Option>:</Term>
-<ListItem>
-<Para>
-strictness analyser output
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-ddump-workwrap</Option>:</Term>
-<ListItem>
-<Para>
-worker/wrapper split output
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-ddump-occur-anal</Option>:</Term>
-<ListItem>
-<Para>
-`occurrence analysis' output
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-ddump-stg</Option>:</Term>
-<ListItem>
-<Para>
-output of STG-to-STG passes
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-ddump-absC</Option>:</Term>
-<ListItem>
-<Para>
-<Emphasis>un</Emphasis>flattened Abstract C
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-ddump-flatC</Option>:</Term>
-<ListItem>
-<Para>
-<Emphasis>flattened</Emphasis> Abstract C
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-ddump-realC</Option>:</Term>
-<ListItem>
-<Para>
-same as what goes to the C compiler
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-ddump-asm</Option>:</Term>
-<ListItem>
-<Para>
-assembly language from the native-code generator
-</Para>
-</ListItem>
-</VarListEntry>
-</VariableList>
-<IndexTerm><Primary>-ddump-all option</Primary></IndexTerm>
-<IndexTerm><Primary>-ddump-most option</Primary></IndexTerm>
-<IndexTerm><Primary>-ddump-parsed option</Primary></IndexTerm>
-<IndexTerm><Primary>-ddump-rn option</Primary></IndexTerm>
-<IndexTerm><Primary>-ddump-tc option</Primary></IndexTerm>
-<IndexTerm><Primary>-ddump-deriv option</Primary></IndexTerm>
-<IndexTerm><Primary>-ddump-ds option</Primary></IndexTerm>
-<IndexTerm><Primary>-ddump-simpl option</Primary></IndexTerm>
-<IndexTerm><Primary>-ddump-cpranal option</Primary></IndexTerm>
-<IndexTerm><Primary>-ddump-workwrap option</Primary></IndexTerm>
-<IndexTerm><Primary>-ddump-rules option</Primary></IndexTerm>
-<IndexTerm><Primary>-ddump-usagesp option</Primary></IndexTerm>
-<IndexTerm><Primary>-ddump-stranal option</Primary></IndexTerm>
-<IndexTerm><Primary>-ddump-occur-anal option</Primary></IndexTerm>
-<IndexTerm><Primary>-ddump-spec option</Primary></IndexTerm>
-<IndexTerm><Primary>-ddump-stg option</Primary></IndexTerm>
-<IndexTerm><Primary>-ddump-absC option</Primary></IndexTerm>
-<IndexTerm><Primary>-ddump-flatC option</Primary></IndexTerm>
-<IndexTerm><Primary>-ddump-realC option</Primary></IndexTerm>
-<IndexTerm><Primary>-ddump-asm option</Primary></IndexTerm>
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-dverbose-simpl</Option> and <Option>-dverbose-stg</Option>:</Term>
-<ListItem>
-<Para>
-<IndexTerm><Primary>-dverbose-simpl option</Primary></IndexTerm>
-<IndexTerm><Primary>-dverbose-stg option</Primary></IndexTerm>
-Show the output of the intermediate Core-to-Core and STG-to-STG
-passes, respectively. (<Emphasis>Lots</Emphasis> of output!) So: when we're
-really desperate:
-
-<Screen>
+<sect1 id="options-debugging">
+ <title>Debugging the compiler</title>
+
+ <indexterm><primary>debugging options (for GHC)</primary></indexterm>
+
+ <para>HACKER TERRITORY. HACKER TERRITORY. (You were warned.)</para>
+
+ <Sect2 id="dumping-output">
+ <title>Dumping out compiler intermediate structures</title>
+
+ <indexterm><primary>dumping GHC intermediates</primary></indexterm>
+ <indexterm><primary>intermediate passes, output</primary></indexterm>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>-ddump-</option><replaceable>pass</replaceable></term>
+ <indexterm><primary><option>-ddump</option> options</primary></indexterm>
+ <listitem>
+ <para>Make a debugging dump after pass
+ <literal><pass></literal> (may be common enough to need
+ a short form…). You can get all of these at once
+ (<emphasis>lots</emphasis> of output) by using
+ <option>-v5</option>, or most of them with
+ <option>-v4</option>. Some of the most useful ones
+ are:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>-ddump-parsed</option>:</term>
+ <listitem>
+ <para>parser output</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-rn</option>:</term>
+ <listitem>
+ <para>renamer output</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-tc</option>:</term>
+ <listitem>
+ <para>typechecker output</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-types</option>:</term>
+ <listitem>
+ <para>Dump a type signature for each value defined at
+ the top level of the module. The list is sorted
+ alphabetically. Using <option>-dppr-debug</option>
+ dumps a type signature for all the imported and
+ system-defined things as well; useful for debugging the
+ compiler.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-deriv</option>:</term>
+ <listitem>
+ <para>derived instances</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-ds</option>:</term>
+ <listitem>
+ <para>desugarer output</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-spec</option>:</term>
+ <listitem>
+ <para>output of specialisation pass</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-rules</option>:</term>
+ <listitem>
+ <para>dumps all rewrite rules (including those generated
+ by the specialisation pass)</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-simpl</option>:</term>
+ <listitem>
+ <para>simplifer output (Core-to-Core passes)</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-inlinings</option>:</term>
+ <listitem>
+ <para>inlining info from the simplifier</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-usagesp</option>:</term>
+ <listitem>
+ <para>UsageSP inference pre-inf and output</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-cpranal</option>:</term>
+ <listitem>
+ <para>CPR analyser output</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-stranal</option>:</term>
+ <listitem>
+ <para>strictness analyser output</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-cse</option>:</term>
+ <listitem>
+ <para>CSE pass output</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-workwrap</option>:</term>
+ <listitem>
+ <para>worker/wrapper split output</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-occur-anal</option>:</term>
+ <listitem>
+ <para>`occurrence analysis' output</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-sat</option>:</term>
+ <listitem>
+ <para>output of “saturate” pass</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-stg</option>:</term>
+ <listitem>
+ <para>output of STG-to-STG passes</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-absC</option>:</term>
+ <listitem>
+ <para><emphasis>un</emphasis>flattened Abstract C</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-flatC</option>:</term>
+ <listitem>
+ <para><emphasis>flattened</emphasis> Abstract C</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-realC</option>:</term>
+ <listitem>
+ <para>same as what goes to the C compiler</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-stix</option>:</term>
+ <listitem>
+ <para>native-code generator intermediate form</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-asm</option>:</term>
+ <listitem>
+ <para>assembly language from the native-code generator</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-bcos</option>:</term>
+ <listitem>
+ <para>byte code compiler output</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-foreign</option>:</term>
+ <listitem>
+ <para>dump foreign export stubs</para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ <indexterm><primary><option>-ddump-absC</option></primary></indexterm>
+ <indexterm><primary><option>-ddump-bcos</option></primary></indexterm>
+ <indexterm><primary><option>-ddump-cpranal</option></primary></indexterm>
+ <indexterm><primary><option>-ddump-cse</option></primary></indexterm>
+
+ <indexterm><primary><option>-ddump-deriv</option></primary></indexterm>
+ <indexterm><primary><option>-ddump-ds</option></primary></indexterm>
+ <indexterm><primary><option>-ddump-flatC</option></primary></indexterm>
+ <indexterm><primary><option>-ddump-foreign</option></primary></indexterm>
+ <indexterm><primary><option>-ddump-inlinings</option></primary></indexterm>
+ <indexterm><primary><option>-ddump-occur-anal</option></primary></indexterm>
+ <indexterm><primary><option>-ddump-parsed</option></primary></indexterm>
+ <indexterm><primary><option>-ddump-realC</option></primary></indexterm>
+ <indexterm><primary><option>-ddump-rn</option></primary></indexterm>
+ <indexterm><primary><option>-ddump-rules</option></primary></indexterm>
+ <indexterm><primary><option>-ddump-sat</option></primary></indexterm>
+ <indexterm><primary><option>-ddump-simpl</option></primary></indexterm>
+ <indexterm><primary><option>-ddump-spec</option></primary></indexterm>
+ <indexterm><primary><option>-ddump-stg</option></primary></indexterm>
+ <indexterm><primary><option>-ddump-stix</option></primary></indexterm>
+ <indexterm><primary><option>-ddump-stranal</option></primary></indexterm>
+ <indexterm><primary><option>-ddump-tc</option></primary></indexterm>
+
+ <indexterm><primary><option>-ddump-usagesp</option></primary></indexterm>
+ <indexterm><primary><option>-ddump-workwrap</option></primary></indexterm>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-dverbose-core2core</option></term>
+ <term><option>-dverbose-stg2stg</option></term>
+ <indexterm><primary><option>-dverbose-core2core</option></primary></indexterm>
+ <indexterm><primary><option>-dverbose-stg2stg</option></primary></indexterm>
+ <listitem>
+ <para>Show the output of the intermediate Core-to-Core and
+ STG-to-STG passes, respectively. (<emphasis>Lots</emphasis>
+ of output!) So: when we're really desperate:</para>
+
+ <Screen>
% ghc -noC -O -ddump-simpl -dverbose-simpl -dcore-lint Foo.hs
</Screen>
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-ddump-simpl-iterations</Option>:</Term>
-<ListItem>
-<Para>
-<IndexTerm><Primary>-ddump-simpl-iterations option</Primary></IndexTerm>
-Show the output of each <Emphasis>iteration</Emphasis> of the simplifier (each run of
-the simplifier has a maximum number of iterations, normally 4). Used
-when even <Option>-dverbose-simpl</Option> doesn't cut it.
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-dppr-{user,debug</Option>}:</Term>
-<ListItem>
-<Para>
-<IndexTerm><Primary>-dppr-user option</Primary></IndexTerm>
-<IndexTerm><Primary>-dppr-debug option</Primary></IndexTerm>
-Debugging output is in one of several “styles.” Take the printing
-of types, for example. In the “user” style, the compiler's internal
-ideas about types are presented in Haskell source-level syntax,
-insofar as possible. In the “debug” style (which is the default for
-debugging output), the types are printed in with
-explicit foralls, and variables have their unique-id attached (so you
-can check for things that look the same but aren't).
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-ddump-simpl-stats</Option>:</Term>
-<ListItem>
-<Para>
-<IndexTerm><Primary>-ddump-simpl-stats option</Primary></IndexTerm>
-Dump statistics about how many of each kind
-of transformation too place. If you add <Option>-dppr-debug</Option> you get more detailed information.
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-ddump-raw-asm</Option>:</Term>
-<ListItem>
-<Para>
-<IndexTerm><Primary>-ddump-raw-asm option</Primary></IndexTerm>
-Dump out the assembly-language stuff, before the “mangler” gets it.
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-ddump-rn-trace</Option>:</Term>
-<ListItem>
-<Para>
-<IndexTerm><Primary>-ddump-rn-trace</Primary></IndexTerm>
-Make the renamer be *real* chatty about what it is upto.
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-dshow-rn-stats</Option>:</Term>
-<ListItem>
-<Para>
-<IndexTerm><Primary>-dshow-rn-stats</Primary></IndexTerm>
-Print out summary of what kind of information the renamer had to bring
-in.
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-dshow-unused-imports</Option>:</Term>
-<ListItem>
-<Para>
-<IndexTerm><Primary>-dshow-unused-imports</Primary></IndexTerm>
-Have the renamer report what imports does not contribute.
-</Para>
-</ListItem>
-</VarListEntry>
-</VariableList>
-</Para>
-
-</Sect2>
-
-<Sect2 id="checking-consistency">
-<Title>Checking for consistency
-</Title>
-
-<Para>
-<IndexTerm><Primary>consistency checks</Primary></IndexTerm>
-<IndexTerm><Primary>lint</Primary></IndexTerm>
-</Para>
-
-<Para>
-<VariableList>
-
-<VarListEntry>
-<Term><Option>-dcore-lint</Option>:</Term>
-<ListItem>
-<Para>
-<IndexTerm><Primary>-dcore-lint option</Primary></IndexTerm>
-Turn on heavyweight intra-pass sanity-checking within GHC, at Core
-level. (It checks GHC's sanity, not yours.)
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-dstg-lint</Option>:</Term>
-<ListItem>
-<Para>
-<IndexTerm><Primary>-dstg-lint option</Primary></IndexTerm>
-Ditto for STG level.
-</Para>
-</ListItem>
-</VarListEntry>
-<VarListEntry>
-<Term><Option>-dusagesp-lint</Option>:</Term>
-<ListItem>
-<Para>
-<IndexTerm><Primary>-dstg-lint option</Primary></IndexTerm>
-Turn on checks around UsageSP inference (<Option>-fusagesp</Option>). This verifies
-various simple properties of the results of the inference, and also
-warns if any identifier with a used-once annotation before the
-inference has a used-many annotation afterwards; this could indicate a
-non-worksafe transformation is being applied.
-</Para>
-</ListItem>
-</VarListEntry>
-</VariableList>
-</Para>
-
-</Sect2>
-
-<Sect2>
-<Title>How to read Core syntax (from some <Option>-ddump-*</Option> flags)</Title>
-
-<Para>
-<IndexTerm><Primary>reading Core syntax</Primary></IndexTerm>
-<IndexTerm><Primary>Core syntax, how to read</Primary></IndexTerm>
-</Para>
-
-<Para>
-Let's do this by commenting an example. It's from doing
-<Option>-ddump-ds</Option> on this code:
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-simpl-iterations</option>:</term>
+ <indexterm><primary><option>-ddump-simpl-iterations</option></primary></indexterm>
+ <listitem>
+ <para>Show the output of each <emphasis>iteration</emphasis>
+ of the simplifier (each run of the simplifier has a maximum
+ number of iterations, normally 4). Used when even
+ <option>-dverbose-simpl</option> doesn't cut it.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-dppr-debug</option></term>
+ <indexterm><primary><option>-dppr-debug</option></primary></indexterm>
+ <listitem>
+ <para>Debugging output is in one of several
+ “styles.” Take the printing of types, for
+ example. In the “user” style (the default), the
+ compiler's internal ideas about types are presented in
+ Haskell source-level syntax, insofar as possible. In the
+ “debug” style (which is the default for
+ debugging output), the types are printed in with explicit
+ foralls, and variables have their unique-id attached (so you
+ can check for things that look the same but aren't). This
+ flag makes debugging output appear in the more verbose debug
+ style.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-dppr-user-length</option></term>
+ <indexterm><primary><option>-dppr-user-length</option></primary></indexterm>
+ <listitem>
+ <para>In error messages, expressions are printed to a
+ certain “depth”, with subexpressions beyond the
+ depth replaced by ellipses. This flag sets the
+ depth.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-simpl-stats</option></term>
+ <indexterm><primary><option>-ddump-simpl-stats option</option></primary></indexterm>
+ <listitem>
+ <para>Dump statistics about how many of each kind of
+ transformation too place. If you add
+ <option>-dppr-debug</option> you get more detailed
+ information.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-rn-trace</option></term>
+ <indexterm><primary><option>-ddump-rn-trace</option></primary></indexterm>
+ <listitem>
+ <para>Make the renamer be *real* chatty about what it is
+ upto.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ddump-rn-stats</option></term>
+ <indexterm><primary><option>-dshow-rn-stats</option></primary></indexterm>
+ <listitem>
+ <para>Print out summary of what kind of information the renamer
+ had to bring in.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-dshow-unused-imports</option></term>
+ <indexterm><primary><option>-dshow-unused-imports</option></primary></indexterm>
+ <listitem>
+ <para>Have the renamer report what imports does not
+ contribute.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
+
+ <sect2 id="checking-consistency">
+ <title>Checking for consistency</title>
+
+ <indexterm><primary>consistency checks</primary></indexterm>
+ <indexterm><primary>lint</primary></indexterm>
+
+ <variablelist>
+
+ <varlistentry>
+ <term><option>-dcore-lint</option></term>
+ <indexterm><primary><option>-dcore-lint</option></primary></indexterm>
+ <listitem>
+ <para>Turn on heavyweight intra-pass sanity-checking within
+ GHC, at Core level. (It checks GHC's sanity, not yours.)</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-dstg-lint</option>:</term>
+ <indexterm><primary><option>-dstg-lint</option></primary></indexterm>
+ <listitem>
+ <para>Ditto for STG level. (NOTE: currently doesn't work).</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-dusagesp-lint</option>:</term>
+ <indexterm><primary><option>-dstg-lint</option></primary></indexterm>
+ <listitem>
+ <para>Turn on checks around UsageSP inference
+ (<option>-fusagesp</option>). This verifies various simple
+ properties of the results of the inference, and also warns
+ if any identifier with a used-once annotation before the
+ inference has a used-many annotation afterwards; this could
+ indicate a non-worksafe transformation is being
+ applied.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
+
+ <sect2>
+ <title>How to read Core syntax (from some <option>-ddump</option>
+ flags)</title>
+
+ <indexterm><primary>reading Core syntax</primary></indexterm>
+ <indexterm><primary>Core syntax, how to read</primary></indexterm>
+
+ <para>Let's do this by commenting an example. It's from doing
+ <option>-ddump-ds</option> on this code:
<ProgramListing>
skip2 m = m : skip2 (m+2)
</ProgramListing>
-</Para>
-
-<Para>
-Before we jump in, a word about names of things. Within GHC,
-variables, type constructors, etc., are identified by their
-“Uniques.” These are of the form `letter' plus `number' (both
-loosely interpreted). The `letter' gives some idea of where the
-Unique came from; e.g., <Literal>_</Literal> means “built-in type variable”;
-<Literal>t</Literal> means “from the typechecker”; <Literal>s</Literal> means “from the
-simplifier”; and so on. The `number' is printed fairly compactly in
-a `base-62' format, which everyone hates except me (WDP).
-</Para>
-
-<Para>
-Remember, everything has a “Unique” and it is usually printed out
-when debugging, in some form or another. So here we go…
-</Para>
-
-<Para>
+ Before we jump in, a word about names of things. Within GHC,
+ variables, type constructors, etc., are identified by their
+ “Uniques.” These are of the form `letter' plus
+ `number' (both loosely interpreted). The `letter' gives some idea
+ of where the Unique came from; e.g., <literal>_</literal>
+ means “built-in type variable”; <literal>t</literal>
+ means “from the typechecker”; <literal>s</literal>
+ means “from the simplifier”; and so on. The `number'
+ is printed fairly compactly in a `base-62' format, which everyone
+ hates except me (WDP).</para>
+
+ <para>Remember, everything has a “Unique” and it is
+ usually printed out when debugging, in some form or another. So
+ here we go…</para>
+
<ProgramListing>
Desugared:
Main.skip2{-r1L6-} :: _forall_ a$_4 =>{{Num a$_4}} -> a$_4 -> [a$_4]
{- end CoRec -}
} in skip2.t3Ja
</ProgramListing>
-</Para>
-
-<Para>
-(“It's just a simple functional language” is an unregisterised
-trademark of Peyton Jones Enterprises, plc.)
-</Para>
-
-</Sect2>
-
-<Sect2 id="source-file-options">
-<Title>Command line options in source files
-</Title>
-
-<Para>
-<IndexTerm><Primary>source-file options</Primary></IndexTerm>
-</Para>
-
-<Para>
-Sometimes it is useful to make the connection between a source file
-and the command-line options it requires quite tight. For instance,
-if a (Glasgow) Haskell source file uses <Literal>casm</Literal>s, the C back-end
-often needs to be told about which header files to include. Rather than
-maintaining the list of files the source depends on in a
-<Filename>Makefile</Filename> (using the <Option>-#include</Option> command-line option), it is
-possible to do this directly in the source file using the <Literal>OPTIONS</Literal>
-pragma <IndexTerm><Primary>OPTIONS pragma</Primary></IndexTerm>:
-</Para>
-
-<Para>
-<ProgramListing>
-{-# OPTIONS -#include "foo.h" #-}
-module X where
-...
-</ProgramListing>
-</Para>
-
-<Para>
-<Literal>OPTIONS</Literal> pragmas are only looked for at the top of your source
-files, upto the first (non-literate,non-empty) line not containing
-<Literal>OPTIONS</Literal>. Multiple <Literal>OPTIONS</Literal> pragmas are recognised. Note
-that your command shell does not get to the source file options, they
-are just included literally in the array of command-line arguments
-the compiler driver maintains internally, so you'll be desperately
-disappointed if you try to glob etc. inside <Literal>OPTIONS</Literal>.
-</Para>
-
-<Para>
-NOTE: the contents of OPTIONS are prepended to the command-line
-options, so you *do* have the ability to override OPTIONS settings
-via the command line.
-</Para>
-
-<Para>
-It is not recommended to move all the contents of your Makefiles into
-your source files, but in some circumstances, the <Literal>OPTIONS</Literal> pragma
-is the Right Thing. (If you use <Option>-keep-hc-file-too</Option> and have OPTION
-flags in your module, the OPTIONS will get put into the generated .hc
-file).
-</Para>
-
-</Sect2>
+ <para>(“It's just a simple functional language” is an
+ unregisterised trademark of Peyton Jones Enterprises, plc.)</para>
+
+ </sect2>
+
+ <sect2 id="unreg">
+ <title>Unregisterised compilation</title>
+ <indexterm><primary>unregisterised compilation</primary></indexterm>
+
+ <para>The term "unregisterised" really means "compile via vanilla
+ C", disabling some of the platform-specific tricks that GHC
+ normally uses to make programs go faster. When compiling
+ unregisterised, GHC simply generates a C file which is compiled
+ via gcc.</para>
+
+ <para>Unregisterised compilation can be useful when porting GHC to
+ a new machine, since it reduces the prerequisite tools to
+ <command>gcc</command>, <command>as</command>, and
+ <command>ld</command> and nothing more, and furthermore the amount
+ of platform-specific code that needs to be written in order to get
+ unregisterised compilation going is usually fairly small.</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>-unreg</option>:</term>
+ <indexterm><primary><option>-unreg</option></primary></indexterm>
+ <listitem>
+ <para>Compile via vanilla ANSI C only, turning off
+ platform-specific optimisations. NOTE: in order to use
+ <option>-unreg</option>, you need to have a set of libraries
+ (including the RTS) built for unregisterised compilation.
+ This amounts to building GHC with way "u" enabled.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
</Sect1>
+
+<!-- Emacs stuff:
+ ;;; Local Variables: ***
+ ;;; mode: sgml ***
+ ;;; sgml-parent-document: ("users_guide.sgml" "book" "chapter" "sect1") ***
+ ;;; End: ***
+ -->
projects / ghc-hetmet.git / blobdiff