summaryrefslogtreecommitdiff
path: root/mk
diff options
context:
space:
mode:
authorBen Gamari <ben@smart-cactus.org>2022-01-30 08:45:49 -0500
committerMarge Bot <ben+marge-bot@smart-cactus.org>2022-02-01 12:29:26 -0500
commit88fba8a4b3c22e953a634b81dd0b67ec66eb5e72 (patch)
tree75a46332ad32cfeaf4f4d52b3b60fd452f2493b6 /mk
parent06185102bb06d6d56e00d40172a6a473fc228501 (diff)
downloadhaskell-88fba8a4b3c22e953a634b81dd0b67ec66eb5e72.tar.gz
Fix a few Note inconsistencies
Diffstat (limited to 'mk')
-rw-r--r--mk/config.mk.in9
-rw-r--r--mk/warnings.mk2
2 files changed, 6 insertions, 5 deletions
diff --git a/mk/config.mk.in b/mk/config.mk.in
index c13332169d..9476179606 100644
--- a/mk/config.mk.in
+++ b/mk/config.mk.in
@@ -74,8 +74,8 @@ GhcStage2HcOpts=-O2 -haddock
GhcStage3HcOpts=-O2 -haddock
-# Note [Stage number in build variables].
-#
+# Note [Stage number in build variables]
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# There are (unfortunately) two different naming schemes for build variables
# specific to a certain stage.
#
@@ -551,7 +551,7 @@ CrossCompilePrefix = $(if $(filter YES,$(Stage1Only)),@CrossCompilePrefix@,)
INSTALL_GHC_STAGE= $(if $(filter YES,$(Stage1Only)),1,2)
# Note [CrossCompiling vs Stage1Only]
-#
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# There are 4 possible settings:
#
# 1 CrossCompiling=NO Stage1Only=NO
@@ -570,7 +570,7 @@ INSTALL_GHC_STAGE= $(if $(filter YES,$(Stage1Only)),1,2)
# [1] https://gitlab.haskell.org/ghc/ghc/wikis/building/cross-compiling
# Note [Stage1Only vs stage=1]
-#
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# Stage1Only=YES means:
# - don't build ghc-stage2 (the executable)
# - don't build utils that rely on ghc-stage2
@@ -891,6 +891,7 @@ GhcLibHcOpts=
endif
# Note [Disable -O2 in unregisterised mode]
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# Disable -O2 optimization in unregisterised mode. Otherwise amount
# of generated C code # makes things very slow to compile (~5 minutes
# on core-i7 for 'compiler/GHC/Hs/Expr.hs') and sometimes not compile
diff --git a/mk/warnings.mk b/mk/warnings.mk
index ed549aa33a..bdbdc79213 100644
--- a/mk/warnings.mk
+++ b/mk/warnings.mk
@@ -133,7 +133,7 @@ GhcLibExtraHcOpts += -Wno-deprecated-flags
GhcBootLibExtraHcOpts += -fno-warn-deprecated-flags
# Note [Order of warning flags]
-#
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# In distdir-way-opts, build flags are added in the following order (this
# list is not exhaustive):
#