summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Jakobi <simon.jakobi@gmail.com>2018-03-29 12:07:17 +0200
committerBen Gamari <ben@smart-cactus.org>2018-03-29 12:01:21 -0400
commitbf2b9ccc2f4147220b2307c93f90b895e1bea434 (patch)
treeac38ceb75f3fd844e223fda4af4e38ddaea14766
parent88f06d41f76b342193c393b192a219715fb39ff9 (diff)
downloadhaskell-bf2b9ccc2f4147220b2307c93f90b895e1bea434.tar.gz
Update Note [Documenting optimisation flags]
-rw-r--r--compiler/main/DynFlags.hs9
1 files changed, 2 insertions, 7 deletions
diff --git a/compiler/main/DynFlags.hs b/compiler/main/DynFlags.hs
index ba4d281bf0..7c27e52a6b 100644
--- a/compiler/main/DynFlags.hs
+++ b/compiler/main/DynFlags.hs
@@ -4344,16 +4344,11 @@ impliedXFlags
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
-- If you change the list of flags enabled for particular optimisation levels
--- please remember to update the User's Guide. The relevant files are:
+-- please remember to update the User's Guide. The relevant file is:
--
-- docs/users_guide/using-optimisation.rst
--
--- The first contains the Flag Reference section, which briefly lists all
--- available flags. The second contains a detailed description of the
--- flags. Both places should contain information whether a flag is implied by
--- -O0, -O or -O2.
---
--- (See #6087 about adding -flate-dmd-anal in this list)
+-- Make sure to note whether a flag is implied by -O0, -O or -O2.
optLevelFlags :: [([Int], GeneralFlag)]
optLevelFlags -- see Note [Documenting optimisation flags]