Skip to content

Commit

Permalink
Use consistent dashes in the user guide
Browse files Browse the repository at this point in the history
We were using a mixture of "––" and "--". We now
consistently use "--", which has the advantage that copy/pasting
flags will work.
  • Loading branch information
Ian Lynagh committed Jun 22, 2013
1 parent 0cb19bc commit 74a800b
Show file tree
Hide file tree
Showing 12 changed files with 73 additions and 73 deletions.
2 changes: 1 addition & 1 deletion docs/users_guide/ffi-chap.xml
Expand Up @@ -274,7 +274,7 @@ extern HsInt foo(HsInt a0);</programlisting>
<filename>M_stub.o</filename> in the final link command line, or
you'll get link errors for the missing function(s) (this isn't
necessary when building your program with <literal>ghc
&ndash;&ndash;make</literal>, as GHC will automatically link in the
--make</literal>, as GHC will automatically link in the
correct bits).</para>

<sect3 id="using-own-main">
Expand Down
12 changes: 6 additions & 6 deletions docs/users_guide/flags.xml
Expand Up @@ -54,37 +54,37 @@
<entry>-</entry>
</row>
<row>
<entry><option>&ndash;&ndash;supported-extensions</option> or <option>&ndash;&ndash;supported-languages</option></entry>
<entry><option>--supported-extensions</option> or <option>--supported-languages</option></entry>
<entry>display the supported languages and language extensions</entry>
<entry>mode</entry>
<entry>-</entry>
</row>
<row>
<entry><option>&ndash;&ndash;show-options</option></entry>
<entry><option>--show-options</option></entry>
<entry>display the supported command line options</entry>
<entry>mode</entry>
<entry>-</entry>
</row>
<row>
<entry><option>&ndash;&ndash;info</option></entry>
<entry><option>--info</option></entry>
<entry>display information about the compiler</entry>
<entry>mode</entry>
<entry>-</entry>
</row>
<row>
<entry><option>&ndash;&ndash;version</option></entry>
<entry><option>--version</option></entry>
<entry>display GHC version</entry>
<entry>mode</entry>
<entry>-</entry>
</row>
<row>
<entry><option>&ndash;&ndash;numeric-version</option></entry>
<entry><option>--numeric-version</option></entry>
<entry>display GHC version (numeric only)</entry>
<entry>mode</entry>
<entry>-</entry>
</row>
<row>
<entry><option>&ndash;&ndash;print-libdir</option></entry>
<entry><option>--print-libdir</option></entry>
<entry>display GHC library directory</entry>
<entry>mode</entry>
<entry>-</entry>
Expand Down
14 changes: 7 additions & 7 deletions docs/users_guide/ghci.xml
Expand Up @@ -161,7 +161,7 @@ Ok, modules loaded: Main.
<para>or it can be set using the <literal>:set</literal> command
from within GHCi (see <xref
linkend="ghci-cmd-line-options"/>)<footnote><para>Note that in
GHCi, and <option>&ndash;&ndash;make</option> mode, the <option>-i</option>
GHCi, and <option>--make</option> mode, the <option>-i</option>
option is used to specify the search path for
<emphasis>source</emphasis> files, whereas in standard
batch-compilation mode the <option>-i</option> option is used to
Expand Down Expand Up @@ -338,7 +338,7 @@ Compiling A ( A.hs, interpreted )
<para>HINT: since GHCi will only use a compiled object file if it
can be sure that the compiled version is up-to-date, a good technique
when working on a large program is to occasionally run
<literal>ghc &ndash;&ndash;make</literal> to compile the whole project (say
<literal>ghc --make</literal> to compile the whole project (say
before you go for lunch :-), then continue working in the
interpreter. As you modify code, the changed modules will be
interpreted, but the rest of the project will remain
Expand Down Expand Up @@ -1715,7 +1715,7 @@ a :: a
<para>The history is only available when
using <literal>:trace</literal>; the reason for this is we found that
logging each breakpoint in the history cuts performance by a factor of
2 or more. By default, GHCi remembers the last 50 steps in the history, but this can be changed with the <option>-fghci-hist-size=<replaceable>n</replaceable></option><indexterm><primary><option>&ndash;fghci-hist-size</option></primary></indexterm> option).</para>
2 or more. By default, GHCi remembers the last 50 steps in the history, but this can be changed with the <option>-fghci-hist-size=<replaceable>n</replaceable></option><indexterm><primary><option>-fghci-hist-size</option></primary></indexterm> option).</para>
</sect2>

<sect2 id="ghci-debugger-exceptions">
Expand Down Expand Up @@ -1910,10 +1910,10 @@ Just 20
<sect1 id="ghci-invocation">
<title>Invoking GHCi</title>
<indexterm><primary>invoking</primary><secondary>GHCi</secondary></indexterm>
<indexterm><primary><option>&ndash;&ndash;interactive</option></primary></indexterm>
<indexterm><primary><option>--interactive</option></primary></indexterm>

<para>GHCi is invoked with the command <literal>ghci</literal> or
<literal>ghc &ndash;&ndash;interactive</literal>. One or more modules or
<literal>ghc --interactive</literal>. One or more modules or
filenames can also be specified on the command line; this
instructs GHCi to load the specified modules or filenames (and all
the modules they depend on), just as if you had said
Expand Down Expand Up @@ -2255,11 +2255,11 @@ Prelude> :mycd ..
</screen>

<para>Or I could define a simple way to invoke
&ldquo;<literal>ghc &ndash;&ndash;make Main</literal>&rdquo; in the
&ldquo;<literal>ghc --make Main</literal>&rdquo; in the
current directory:</para>

<screen>
Prelude> :def make (\_ -> return ":! ghc &ndash;&ndash;make Main")
Prelude> :def make (\_ -> return ":! ghc --make Main")
</screen>

<para>We can define a command that reads GHCi input from a
Expand Down
2 changes: 1 addition & 1 deletion docs/users_guide/intro.xml
Expand Up @@ -302,7 +302,7 @@

<para>The version number of your copy of GHC can be found by
invoking <literal>ghc</literal> with the
<literal>&ndash;&ndash;version</literal> flag (see <xref
<literal>--version</literal> flag (see <xref
linkend="options-help"/>).</para>
</sect1>

Expand Down
24 changes: 12 additions & 12 deletions docs/users_guide/packages.xml
Expand Up @@ -13,7 +13,7 @@ Packages
url="http://hackage.haskell.org/packages/hackage.html">HackageDB</ulink>.</para>

<para>Using a package couldn't be simpler: if you're using
<option>&ndash;&ndash;make</option> or GHCi, then most of the installed packages will be
<option>--make</option> or GHCi, then most of the installed packages will be
automatically available to your program without any further options. The
exceptions to this rule are covered below in <xref
linkend="using-packages" />.</para>
Expand Down Expand Up @@ -147,8 +147,8 @@ exposed-modules: Network.BSD,
or dynamically is controlled by the flag
pair <option>-static</option>/<option>-dynamic</option>.</para>

<para>In <option>&ndash;&ndash;make</option> mode
and <option>&ndash;&ndash;interactive</option> mode (see
<para>In <option>--make</option> mode
and <option>--interactive</option> mode (see
<xref linkend="modes" />), the compiler normally
determines which packages are required by the current
Haskell modules, and links only those. In batch mode
Expand Down Expand Up @@ -961,9 +961,9 @@ ghc-pkg dot | tred | dot -Tpdf >pkgs.pdf

<varlistentry>
<term>
<option>&ndash;&ndash;force</option>
<option>--force</option>
<indexterm><primary>
<option>&ndash;&ndash;force</option>
<option>--force</option>
</primary></indexterm>
</term>
<listitem>
Expand All @@ -977,7 +977,7 @@ ghc-pkg dot | tred | dot -Tpdf >pkgs.pdf

<varlistentry>
<term>
<option>&ndash;&ndash;global</option><indexterm><primary><option>&ndash;&ndash;global</option></primary>
<option>--global</option><indexterm><primary><option>--global</option></primary>
</indexterm>
</term>
<listitem>
Expand All @@ -991,7 +991,7 @@ ghc-pkg dot | tred | dot -Tpdf >pkgs.pdf

<varlistentry>
<term>
<option>&ndash;&ndash;help</option><indexterm><primary><option>&ndash;&ndash;help</option></primary>
<option>--help</option><indexterm><primary><option>--help</option></primary>
</indexterm>
</term>
<term>
Expand All @@ -1005,7 +1005,7 @@ ghc-pkg dot | tred | dot -Tpdf >pkgs.pdf

<varlistentry>
<term>
<option>&ndash;&ndash;user</option><indexterm><primary><option>&ndash;&ndash;user</option></primary>
<option>--user</option><indexterm><primary><option>--user</option></primary>
</indexterm>
</term>
<listitem>
Expand Down Expand Up @@ -1040,7 +1040,7 @@ ghc-pkg dot | tred | dot -Tpdf >pkgs.pdf
</indexterm>
</term>
<term>
<option>&ndash;&ndash;version</option><indexterm><primary><option>&ndash;&ndash;version</option></primary>
<option>--version</option><indexterm><primary><option>--version</option></primary>
</indexterm>
</term>
<listitem>
Expand Down Expand Up @@ -1115,11 +1115,11 @@ ghc-pkg dot | tred | dot -Tpdf >pkgs.pdf
it. To build one manually, the following
GNU <command>ld</command> command can be used:</para>

<screen>ld -r &ndash;&ndash;whole-archive -o HSfoo.o libHSfoo.a</screen>
<screen>ld -r --whole-archive -o HSfoo.o libHSfoo.a</screen>

<para>(replace
<literal>&ndash;&ndash;whole-archive</literal> with
<literal>&ndash;all_load</literal> on MacOS X)</para>
<literal>--whole-archive</literal> with
<literal>-all_load</literal> on MacOS X)</para>
</listitem>
<listitem>
<para>When building the package as shared library, GHC can be used to
Expand Down
2 changes: 1 addition & 1 deletion docs/users_guide/phases.xml
Expand Up @@ -693,7 +693,7 @@ $ cat foo.hspp</screen>
</term>
<listitem>
<para>Omits the link step. This option can be used with
<option>&ndash;&ndash;make</option> to avoid the automatic linking
<option>--make</option> to avoid the automatic linking
that takes place if the program contains a <literal>Main</literal>
module.</para>
</listitem>
Expand Down
2 changes: 1 addition & 1 deletion docs/users_guide/profiling.xml
Expand Up @@ -1077,7 +1077,7 @@ MAIN MAIN 102 0 0.0 0.0 100.0 1
</sect1>

<sect1 id="hp2ps">
<title><command>hp2ps</command>&ndash;&ndash;heap profile to PostScript</title>
<title><command>hp2ps</command>--heap profile to PostScript</title>

<indexterm><primary><command>hp2ps</command></primary></indexterm>
<indexterm><primary>heap profiles</primary></indexterm>
Expand Down
2 changes: 1 addition & 1 deletion docs/users_guide/runtime_control.xml
Expand Up @@ -100,7 +100,7 @@ $ ./prog -f +RTS -H32m -S -RTS -h foo bar
<para>
If you absolutely positively want all the rest of the options
in a command line to go to the program (and not the RTS), use a
<option>&ndash;&ndash;RTS</option><indexterm><primary><option>--RTS</option></primary></indexterm>.
<option>--RTS</option><indexterm><primary><option>--RTS</option></primary></indexterm>.
</para>

<para>
Expand Down
6 changes: 3 additions & 3 deletions docs/users_guide/separate_compilation.xml
Expand Up @@ -1037,7 +1037,7 @@ M.o : X.hi-boot
locate any imported modules that come from packages. The
package modules won't be included in the dependencies
generated, though (but see the
<option>&ndash;&ndash;include-pkg-deps</option> option below).</para>
<option>--include-pkg-deps</option> option below).</para>

<para>The dependency generation phase of GHC can take some
additional options, which you may find useful.
Expand Down Expand Up @@ -1104,7 +1104,7 @@ M.o : X.hi-boot
</varlistentry>

<varlistentry>
<term><option>&ndash;&ndash;exclude-module=&lt;file&gt;</option></term>
<term><option>--exclude-module=&lt;file&gt;</option></term>
<listitem>
<para>Regard <filename>&lt;file&gt;</filename> as
"stable"; i.e., exclude it from having dependencies on
Expand All @@ -1113,7 +1113,7 @@ M.o : X.hi-boot
</varlistentry>

<varlistentry>
<term><option>&ndash;&ndash;include-pkg-deps</option></term>
<term><option>--include-pkg-deps</option></term>
<listitem>
<para>Regard modules imported from packages as unstable,
i.e., generate dependencies on any imported package modules
Expand Down

0 comments on commit 74a800b

Please sign in to comment.