Skip to content

GitLab

Commit 05dfbd74 authored by simonmar's avatar simonmar
Browse files

[project @ 2001-02-16 17:35:01 by simonmar] 

Today's doc hacking.
parent 8487ac4c
Expand all Hide whitespace changes
Inline Side-by-side
ghc/docs/users_guide/debugging.sgml
View file @ 05dfbd74
This diff is collapsed.
ghc/docs/users_guide/flags.sgml
View file @ 05dfbd74
<sect1>
<sect1 id="flag-reference">
<title>Flag reference</title>
<para>This section is a quick-reference for GHC's command-line
flags. For each flag, we also list its static/dynamic status (see
<xref linkend="static-dynamic-flags">), and the flag's opposite
(if available).</para>
<sect2>
<title>Help and verbosity options (<xref linkend="options-help">)</title>
......@@ -70,12 +75,6 @@
</row>
</thead>
<tbody>
<row>
<entry><option>-cpp</option></entry>
<entry>Run the C pre-processor on the Haskell source</entry>
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-E</option></entry>
<entry>Stop after preprocessing (<literal>.hspp</literal> file)</entry>
......@@ -100,18 +99,6 @@
<entry>static</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-fasm</option></entry>
<entry>Use the native code generator</entry>
<entry>dynamic</entry>
<entry>-fvia-C</entry>
</row>
<row>
<entry><option>-fvia-C</option></entry>
<entry>Compile via C</entry>
<entry>dynamic</entry>
<entry>-fasm</entry>
</row>
</tbody>
</tgroup>
</informaltable>
......@@ -324,7 +311,7 @@
<entry><option>-no-recomp</option></entry>
<entry>Turn off recompilation checking</entry>
<entry>static</entry>
<entry>-recomp</entry>
<entry><option>-recomp</option></entry>
</row>
</tbody>
</tgroup>
......@@ -934,6 +921,12 @@
</row>
</thead>
<tbody>
<row>
<entry><option>-cpp</option></entry>
<entry>Run the C pre-processor on Haskell source files</entry>
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-D</option><replaceable>symbol</replaceable><optional>=<replaceable>value</replaceable></optional></entry>
<entry>Define a symbol in the C pre-processor</entry>
......@@ -983,6 +976,37 @@
</informaltable>
</sect2>
<sect2>
<title>Code generation options (<xref linkend="options-codegen">)</title>
<informaltable>
<tgroup cols=3 align=left colsep=1 rowsep=1>
<thead>
<row>
<entry>Flag</entry>
<entry>Description</entry>
<entry>Static/Dynamic</entry>
<entry>Reverse</entry>
</row>
</thead>
<tbody>
<row>
<entry><option>-fasm</option></entry>
<entry>Use the native code generator</entry>
<entry>dynamic</entry>
<entry>-fvia-C</entry>
</row>
<row>
<entry><option>-fvia-C</option></entry>
<entry>Compile via C</entry>
<entry>dynamic</entry>
<entry>-fasm</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect2>
<sect2>
<title>Linking options (<xref linkend="options-linker">)</title>
......@@ -1196,12 +1220,6 @@
<entry>static</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-mlong-calls</option></entry>
<entry>(HPPA only) enable long call support</entry>
<entry>static</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-monly-[32]-regs</option></entry>
<entry>(x86 only) give some registers back to the C compiler</entry>
......@@ -1283,7 +1301,7 @@
</row>
<row>
<entry><option>-ddump-foreign</option></entry>
<entry>Dump FFI-related output</entry>
<entry>Dump <literal>foreign export</literal> stubs</entry>
<entry>dynamic</entry>
<entry>-</entry>
</row>
......@@ -1383,12 +1401,6 @@
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-dshow-passes</option></entry>
<entry>(equivalent to <option>-v2</option>)</entry>
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-ddump-rn-trace</option></entry>
<entry>Trace renamer</entry>
......@@ -1467,6 +1479,12 @@
<entry>dynamic</entry>
<entry>-</entry>
</row>
<row>
<entry><option>-unreg</option></entry>
<entry>Enable unregisterised compilation</entry>
<entry>static</entry>
<entry>-</entry>
</row>
</tbody>
</tgroup>
</informaltable>
......@@ -1566,7 +1584,7 @@ Misc:
, ( "H" , HasArg (setHeapSize . fromIntegral . decodeSize) )
, ( "Rghc-timing" , NoArg (enableTimingStats) )
, ( "unreg" , NoArg (addNoDups v_Ways WayUnreg) )
-Bdir
-->
<!-- Emacs stuff:
......
ghc/docs/users_guide/ghci.sgml 0 → 100644
View file @ 05dfbd74
<chapter>
<title>Using GHCi</title>
<para>ToDo</para>
</chapter>
<!-- Emacs stuff:
;;; Local Variables: ***
;;; mode: sgml ***
;;; sgml-parent-document: ("users_guide.sgml" "book" "chapter") ***
;;; End: ***
-->
ghc/docs/users_guide/phases.sgml
View file @ 05dfbd74
......@@ -41,14 +41,22 @@
<indexterm><primary>C pre-processor options</primary></indexterm>
<indexterm><primary>cpp, pre-processing with</primary></indexterm>
<para>The C pre-processor <command>cpp</command> is run over
your Haskell code only if the <option>-cpp</option> option
<indexterm><primary>-cpp option</primary></indexterm> is given.
Unless you are building a large system with significant doses of
conditional compilation, you really shouldn't need it.</para>
<variablelist>
<varlistentry>
<term><option>-cpp</option></term>
<indexterm><primary><option>-cpp</option></primary></indexterm>
<listitem>
<para>The C pre-processor <command>cpp</command> is run
over your Haskell code only if the <option>-cpp</option>
option <indexterm><primary>-cpp
option</primary></indexterm> is given. Unless you are
building a large system with significant doses of
conditional compilation, you really shouldn't need
it.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-D</option><replaceable>symbol</replaceable><optional>=<replaceable>value</replaceable></optional></term>
<indexterm><primary><option>-D</option></primary></indexterm>
......@@ -203,28 +211,6 @@ strmod = "\
<indexterm><primary>C compiler options</primary></indexterm>
<indexterm><primary>GCC options</primary></indexterm>
<informaltable>
<tgroup cols=3 align=left colsep=1 rowsep=1>
<thead>
<row>
<entry>Flag</entry>
<entry>Description</entry>
<entry>Static/Dynamic</entry>
<entry>Reverse</entry>
</row>
</thead>
<tbody>
<row>
<entry><option>-#include</option> <replaceable>file</replaceable></entry>
<entry>Include <replaceable>file</replaceable> when
compiling the <filename>.hc</filename> file</entry>
<entry>dynamic</entry>
<entry>-</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>If you are compiling with lots of foreign calls, you may
need to tell the C&nbsp;compiler about some
<literal>&num;include</literal> files. There is no real pretty
......@@ -237,6 +223,37 @@ strmod = "\
</sect2>
<sect2 id="options-codegen">
<title>Options affecting code generation</title>
<variablelist>
<varlistentry>
<term><option>-fasm</option></term>
<indexterm><primary><option>-fasm</option></primary></indexterm>
<listitem>
<para>Use GHC's native code generator rather than
compiling via C. This will compile faster (up to twice as
fast), but may produce code that is slightly slower than
compiling via C. <option>-fasm</option> is the default
when optimisation is off (see <xref
linkend="options-optimise">).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-fvia-C</option></term>
<indexterm><primary><option>-fvia-C</option></primary>
</indexterm>
<listitem>
<para>Compile via C instead of using the native code
generator. This is default for optimised compilations,
and on architectures for which GHC doesn't have a native
code generator.</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 id="options-linker">
<title>Options affecting linking</title>
......
ghc/docs/users_guide/separate_compilation.sgml
View file @ 05dfbd74
......@@ -7,7 +7,7 @@
<para>This section describes how GHC supports separate
compilation.</para>
<sect2 id="hi-files">
<title>Interface files</title>
......
ghc/docs/users_guide/ug-book.sgml
View file @ 05dfbd74
......@@ -6,14 +6,15 @@
</Address>
</BookInfo>
&license
&intro
&installing
&using
&prof
&sooner
&lang-features
&ffi-chap
&wrong
&utils
&win32-dll
&license;
&intro;
&installing;
&using;
&ghci;
&prof;
&sooner;
&lang-features;
&ffi-chap;
&wrong;
&utils;
&win32-dll;
ghc/docs/users_guide/ug-ent.sgml
View file @ 05dfbd74
<!ENTITY ghci SYSTEM "ghci.sgml">
<!ENTITY flags SYSTEM "flags.sgml">
<!ENTITY license SYSTEM "license.sgml">
<!ENTITY intro SYSTEM "intro.sgml" >
......
ghc/docs/users_guide/using.sgml
View file @ 05dfbd74
This diff is collapsed.
Supports Markdown
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