Commit ba5729e5 authored by Ian Lynagh's avatar Ian Lynagh

Improve the correlation betweens documented and existent options

parent f83e51a5
......@@ -171,7 +171,6 @@
<option>-pgma</option>,
<option>-pgml</option>,
<option>-pgmdll</option>,
<option>-pgmdep</option>,
<option>-pgmF</option>,
<option>-optl</option>,
<option>-optdll</option>,
......
......@@ -58,6 +58,27 @@
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-ddump-tc</option>:
<indexterm><primary><option>-ddump-tc</option></primary></indexterm>
</term>
<listitem>
<para>typechecker output</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-ddump-splices</option>:
<indexterm><primary><option>-ddump-splices</option></primary></indexterm>
</term>
<listitem>
<para>Dump Template Haskell expressions that we splice in,
and what Haskell code the expression evaluates to.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-ddump-types</option>:
......@@ -184,6 +205,16 @@
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-ddump-prep</option>:
<indexterm><primary><option>-ddump-prep</option></primary></indexterm>
</term>
<listitem>
<para>output of core preparation pass</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-ddump-stg</option>:
......@@ -204,6 +235,26 @@
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-ddump-cmm</option>:
<indexterm><primary><option>-ddump-cmm</option></primary></indexterm>
</term>
<listitem>
<para>Print the C-- code out.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-ddump-opt-cmm</option>:
<indexterm><primary><option>-ddump-opt-cmm</option></primary></indexterm>
</term>
<listitem>
<para>Dump the results of C-- to C-- optimising passes.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-ddump-asm</option>:
......@@ -263,6 +314,28 @@
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-ddump-if-trace</option>
<indexterm><primary><option>-ddump-if-trace</option></primary></indexterm>
</term>
<listitem>
<para>Make the interface loader be *real* chatty about what it is
upto.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-ddump-tc-trace</option>
<indexterm><primary><option>-ddump-tc-trace</option></primary></indexterm>
</term>
<listitem>
<para>Make the type checker be *real* chatty about what it is
upto.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-ddump-rn-trace</option>
......@@ -306,6 +379,16 @@
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-dshow-passes</option>
<indexterm><primary><option>-dshow-passes</option></primary></indexterm>
</term>
<listitem>
<para>Print out each pass name as it happens.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-dfaststring-stats</option>
......@@ -313,7 +396,7 @@
</term>
<listitem>
<para>Show statistics for the usage of fast strings by the
compiler</para>
compiler.</para>
</listitem>
</varlistentry>
......@@ -392,6 +475,16 @@
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-dcmm-lint</option>:
<indexterm><primary><option>-dcmm-lint</option></primary></indexterm>
</term>
<listitem>
<para>Ditto for C-- level.</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
......
......@@ -35,6 +35,12 @@
<entry>mode</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-n</option></entry>
<entry>do a dry run</entry>
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-v</option></entry>
<entry>verbose mode (equivalent to <option>-v3</option>)</entry>
......@@ -77,6 +83,12 @@
<entry>static</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-H</option><replaceable>size</replaceable></entry>
<entry>Set the minimum heap size to <replaceable>size</replaceable></entry>
<entry>static</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-Rghc-timing</option></entry>
<entry>Summarise timing stats for GHC (same as <literal>+RTS -tstderr</literal>)</entry>
......@@ -486,6 +498,12 @@
</row>
</thead>
<tbody>
<row>
<entry><option>-package-name</option> <replaceable>P</replaceable></entry>
<entry>Compile to be part of package <replaceable>P</replaceable></entry>
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-package</option> <replaceable>P</replaceable></entry>
<entry>Expose package <replaceable>P</replaceable></entry>
......@@ -1244,6 +1262,12 @@
</row>
</thead>
<tbody>
<row>
<entry><option>-fPIC</option></entry>
<entry>Generate position-independent code (where available)</entry>
<entry>static</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-dynamic</option></entry>
<entry>Use dynamic Haskell libraries (if available)</entry>
......@@ -1366,6 +1390,18 @@
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-pgmm</option> <replaceable>cmd</replaceable></entry>
<entry>Use <replaceable>cmd</replaceable> as the mangler</entry>
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-pgms</option> <replaceable>cmd</replaceable></entry>
<entry>Use <replaceable>cmd</replaceable> as the splitter</entry>
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-pgma</option> <replaceable>cmd</replaceable></entry>
<entry>Use <replaceable>cmd</replaceable> as the assembler</entry>
......@@ -1384,12 +1420,6 @@
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-pgmdep</option> <replaceable>cmd</replaceable></entry>
<entry>Use <replaceable>cmd</replaceable> as the dependency generator</entry>
<entry>dyanmic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-pgmF</option> <replaceable>cmd</replaceable></entry>
<entry>Use <replaceable>cmd</replaceable> as the pre-processor
......@@ -1406,7 +1436,6 @@
<indexterm><primary><option>-pgma</option></primary></indexterm>
<indexterm><primary><option>-pgml</option></primary></indexterm>
<indexterm><primary><option>-pgmdll</option></primary></indexterm>
<indexterm><primary><option>-pgmdep</option></primary></indexterm>
<indexterm><primary><option>-pgmF</option></primary></indexterm>
</sect2>
......@@ -1453,6 +1482,12 @@
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-optm</option> <replaceable>option</replaceable></entry>
<entry>pass <replaceable>option</replaceable> to the mangler</entry>
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-opta</option> <replaceable>option</replaceable></entry>
<entry>pass <replaceable>option</replaceable> to the assembler</entry>
......@@ -1572,6 +1607,12 @@
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-ddump-cmm</option></entry>
<entry>Dump C-- output</entry>
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-ddump-cpranal</option></entry>
<entry>Dump output from CPR analysis</entry>
......@@ -1620,12 +1661,24 @@
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-ddump-opt-cmm</option></entry>
<entry>Dump the results of C-- to C-- optimising passes</entry>
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-ddump-parsed</option></entry>
<entry>Dump parse tree</entry>
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-ddump-prep</option></entry>
<entry>Dump prepared core</entry>
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-ddump-rn</option></entry>
<entry>Dump renamer output</entry>
......@@ -1656,6 +1709,12 @@
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-ddump-splices</option></entry>
<entry>Dump TH splided expressions, and what they evaluate to</entry>
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-ddump-stg</option></entry>
<entry>Dump final STG</entry>
......@@ -1686,6 +1745,18 @@
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-ddump-if-trace</option></entry>
<entry>Trace interface files</entry>
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-ddump-tc-trace</option></entry>
<entry>Trace typechecker</entry>
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-ddump-rn-trace</option></entry>
<entry>Trace renamer</entry>
......@@ -1728,6 +1799,12 @@
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-dcmm-lint</option></entry>
<entry>C-- pass sanity checking</entry>
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-dstg-lint</option></entry>
<entry>STG pass sanity checking</entry>
......@@ -1752,6 +1829,12 @@
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-dshow-passes</option></entry>
<entry>Print out each pass name as it happens</entry>
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-dfaststring-stats</option></entry>
<entry>Show statistics for fast string usage when finished</entry>
......
......@@ -47,6 +47,28 @@
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-pgmm</option> <replaceable>cmd</replaceable>
<indexterm><primary><option>-pgmm</option></primary></indexterm>
</term>
<listitem>
<para>Use <replaceable>cmd</replaceable> as the
mangler.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-pgms</option> <replaceable>cmd</replaceable>
<indexterm><primary><option>-pgms</option></primary></indexterm>
</term>
<listitem>
<para>Use <replaceable>cmd</replaceable> as the
splitter.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-pgma</option> <replaceable>cmd</replaceable>
......@@ -80,17 +102,6 @@
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-pgmdep</option> <replaceable>cmd</replaceable>
<indexterm><primary><option>-pgmdep</option></primary></indexterm>
</term>
<listitem>
<para>Use <replaceable>cmd</replaceable> as the dependency
generator.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-pgmF</option> <replaceable>cmd</replaceable>
......@@ -153,6 +164,15 @@
<para>Pass <replaceable>option</replaceable> to the C compiler.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-optm</option> <replaceable>option</replaceable>
<indexterm><primary><option>-optm</option></primary></indexterm>
</term>
<listitem>
<para>Pass <replaceable>option</replaceable> to the mangler.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-opta</option> <replaceable>option</replaceable>
......
......@@ -590,6 +590,18 @@ ghc -c Foo.hs</screen>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-n</option>
<indexterm><primary><option>-n</option></primary></indexterm>
</term>
<listitem>
<para>Does a dry-run, i.e. GHC goes through all the motions
of compiling as normal, but does not actually run any
external commands.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-v</option>
......@@ -747,6 +759,20 @@ ghc -c Foo.hs</screen>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-H</option><replaceable>size</replaceable>
<indexterm><primary><option>-H</option></primary></indexterm>
</term>
<listitem>
<para>Set the minimum size of the heap to
<replaceable>size</replaceable>.
This option is equivalent to
<literal>+RTS&nbsp;-H<replaceable>size</replaceable></literal>,
see <xref linkend="rts-options-gc" />.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-Rghc-timing</option>
<indexterm><primary><option>-Rghc-timing</option></primary></indexterm>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment