summaryrefslogtreecommitdiff
path: root/docs/users_guide/using-optimisation.rst
diff options
context:
space:
mode:
authorSantiago Munin <santimunin@gmail.com>2017-06-08 15:03:58 -0400
committerBen Gamari <ben@smart-cactus.org>2017-06-08 15:35:59 -0400
commitb2b416014e4276ebb660d85c3a612f7ca45ade78 (patch)
tree54f626eaa0d40a75878e93b0798f137a25e5827b /docs/users_guide/using-optimisation.rst
parentb10d3f36250d435f9f13079dd9e3ec1ecbb0017f (diff)
downloadhaskell-b2b416014e4276ebb660d85c3a612f7ca45ade78.tar.gz
Correct optimization flags documentation
In a previous change (commit 4fd6207ec6960c429e6a1bcbe0282f625010f52a), the users guide was moved from XML to the RST format. This process introduced a typo: "No -O*-type option specified:" was changed to "-O*" (which is not correct). This change fixes it. See result in: https://prnt.sc/fh332n Fixes ticket #13756. Reviewers: austin, bgamari Reviewed By: bgamari Subscribers: rwbarton, thomie GHC Trac Issues: #13756 Differential Revision: https://phabricator.haskell.org/D3631
Diffstat (limited to 'docs/users_guide/using-optimisation.rst')
-rw-r--r--docs/users_guide/using-optimisation.rst8
1 files changed, 3 insertions, 5 deletions
diff --git a/docs/users_guide/using-optimisation.rst b/docs/users_guide/using-optimisation.rst
index 1e74b71130..88356dfb85 100644
--- a/docs/users_guide/using-optimisation.rst
+++ b/docs/users_guide/using-optimisation.rst
@@ -45,11 +45,9 @@ optimisation to be performed, which can have an impact on how much of
your program needs to be recompiled when you change something. This is
one reason to stick to no-optimisation when developing code.
-.. ghc-flag:: -O*
-
- This is taken to mean: “Please compile quickly; I'm not
- over-bothered about compiled-code quality.” So, for example:
- ``ghc -c Foo.hs``
+**No ``-O*``-type option specified:** This is taken to mean “Please
+compile quickly; I'm not over-bothered about compiled-code quality.”
+So, for example, ``ghc -c Foo.hs``
.. ghc-flag:: -O0