[commit: ghc] master: Update Note [Documenting optimisation flags] (bf2b9cc)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/ghc

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/bf2b9ccc2f4147220b2307c93f90b895e1bea434/ghc

>---------------------------------------------------------------

commit bf2b9ccc2f4147220b2307c93f90b895e1bea434
Author: Simon Jakobi <simon.jakobi at gmail.com>
Date:   Thu Mar 29 12:07:17 2018 +0200

    Update Note [Documenting optimisation flags]


>---------------------------------------------------------------

bf2b9ccc2f4147220b2307c93f90b895e1bea434
 compiler/main/DynFlags.hs | 9 ++-------
 1 file changed, 2 insertions(+), 7 deletions(-)

diff --git a/compiler/main/DynFlags.hs b/compiler/main/DynFlags.hs
index ba4d281..7c27e52 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]