Document how -O3 is handled by GHC
authorGiles Anderson <agander@gmail.com>
Tue, 9 Apr 2019 19:51:21 +0000 (21:51 +0200)
committerMarge Bot <ben+marge-bot@smart-cactus.org>
Mon, 15 Apr 2019 10:20:29 +0000 (06:20 -0400)
    -O2 is the highest value of optimization.
    -O3 will be reverted to -O2.

docs/users_guide/using-optimisation.rst

index 95adb22..990c396 100644 (file)
@@ -88,6 +88,17 @@ So, for example, ``ghc -c Foo.hs``
     runtime or space *worse* if you're unlucky. They are normally turned
     on or off individually.
 
+.. ghc-flag:: -On
+    :shortdesc: Any -On where n > 2 is the same as -O2.
+    :type: dynamic
+    :reverse: -O0
+    :category: optimization-levels
+
+    .. index::
+       single: optimise; aggressively
+
+    Any -On where n > 2 is the same as -O2.
+
 We don't use a ``-O*`` flag for day-to-day work. We use ``-O`` to get
 respectable speed; e.g., when we want to measure something. When we want
 to go for broke, we tend to use ``-O2`` (and we go for lots of coffee