summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJohan Tibell <johan.tibell@gmail.com>2012-12-07 11:56:51 -0800
committerJohan Tibell <johan.tibell@gmail.com>2012-12-07 13:47:54 -0800
commit7bf6eb9a86c160a54ea3df553ade040d5c37c627 (patch)
treea010ddcbf12d40ec62ef7b4513aeb228b36203be /docs
parentc1c2d849789fac798923364ea75316ee73fce101 (diff)
downloadhaskell-7bf6eb9a86c160a54ea3df553ade040d5c37c627.tar.gz
Minor twiddle to -funbox-strict-primitive-fields docs
Diffstat (limited to 'docs')
-rw-r--r--docs/users_guide/using.xml13
1 files changed, 10 insertions, 3 deletions
diff --git a/docs/users_guide/using.xml b/docs/users_guide/using.xml
index fb1a7ccd0b..918176f418 100644
--- a/docs/users_guide/using.xml
+++ b/docs/users_guide/using.xml
@@ -1871,9 +1871,9 @@ f "2" = 2
<para>This option causes all constructor fields which are marked
strict (i.e. &ldquo;!&rdquo;) and which representation is smaller or
equal to the size of a pointer to be unpacked if possible. It is
- equivalent to adding an <literal>UNPACK</literal> pragma to every
- strict constructor field that fullfills the size restriction. (see
- <xref linkend="unpack-pragma"/>).
+ equivalent to adding an <literal>UNPACK</literal> pragma (see <xref
+ linkend="unpack-pragma"/>) to every strict constructor field that
+ fullfills the size restriction.
</para>
<para>This option is less of a sledgehammer than
@@ -1882,6 +1882,13 @@ f "2" = 2
to turn on unboxing by default you can disable it for certain
constructor fields using the <literal>NOUNPACK</literal> pragma (see
<xref linkend="nounpack-pragma"/>).</para>
+
+ <para>
+ Note that for consistency <literal>Double</literal>,
+ <literal>Word64</literal>, and <literal>Int64</literal> constructor
+ fields are unpacked on 32-bit platforms, even though they are
+ technically larger than a pointer on those platforms.
+ </para>
</listitem>
</varlistentry>