summaryrefslogtreecommitdiff
path: root/utils
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 /utils
parent06185102bb06d6d56e00d40172a6a473fc228501 (diff)
downloadhaskell-88fba8a4b3c22e953a634b81dd0b67ec66eb5e72.tar.gz
Fix a few Note inconsistencies
Diffstat (limited to 'utils')
-rw-r--r--utils/check-exact/ExactPrint.hs1
-rw-r--r--utils/genapply/Main.hs4
-rw-r--r--utils/ghc-cabal/Main.hs3
-rw-r--r--utils/ghc-pkg/Main.hs3
-rw-r--r--utils/ghc-pkg/ghc.mk2
-rwxr-xr-xutils/llvm-targets/gen-data-layout.sh2
6 files changed, 7 insertions, 8 deletions
diff --git a/utils/check-exact/ExactPrint.hs b/utils/check-exact/ExactPrint.hs
index 967ae61035..95a0348593 100644
--- a/utils/check-exact/ExactPrint.hs
+++ b/utils/check-exact/ExactPrint.hs
@@ -868,7 +868,6 @@ exactDataFamInstDecl an top_lvl
{-
Note [an and an2 in exactDataFamInstDecl]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
The exactDataFamInstDecl function is called to render a
DataFamInstDecl within its surrounding context. This context is
rendered via the 'pp_hdr' function, which uses the exact print
diff --git a/utils/genapply/Main.hs b/utils/genapply/Main.hs
index a0209966db..7166968ddd 100644
--- a/utils/genapply/Main.hs
+++ b/utils/genapply/Main.hs
@@ -509,8 +509,8 @@ genMkPAP regstatus macro jump live ticker disamb
-- Note [jump_SAVE_CCCS]
-
--- when profiling, if we have some extra arguments to apply that we
+-- ~~~~~~~~~~~~~~~~~~~~~
+-- When profiling, if we have some extra arguments to apply that we
-- save to the stack, we must also save the current cost centre stack
-- and restore it when applying the extra arguments. This is all
-- handled by the macro jump_SAVE_CCCS(target), defined in
diff --git a/utils/ghc-cabal/Main.hs b/utils/ghc-cabal/Main.hs
index e6df477238..0514af148d 100644
--- a/utils/ghc-cabal/Main.hs
+++ b/utils/ghc-cabal/Main.hs
@@ -390,7 +390,8 @@ generate directory distdir config_args
fixupRtsLibName x = x
transitiveDepNames = map (display . packageName) transitive_dep_ids
- -- Note [Msys2 path translation bug].
+ -- Note [Msys2 path translation bug]
+ -- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- Msys2 has an annoying bug in their path conversion code.
-- Officially anything starting with a drive letter should not be
-- subjected to path translations, however it seems to only consider
diff --git a/utils/ghc-pkg/Main.hs b/utils/ghc-pkg/Main.hs
index bb6ee4d9fa..c977cb89c0 100644
--- a/utils/ghc-pkg/Main.hs
+++ b/utils/ghc-pkg/Main.hs
@@ -1292,7 +1292,7 @@ updateDBCache verbosity db db_stack = do
hasAnyAbiDepends x = length (abiDepends x) > 0
-- warn when we find any (possibly-)bogus abi-depends fields;
- -- Note [Recompute abi-depends]
+ -- See Note [Recompute abi-depends]
when (verbosity >= Normal) $ do
let definitelyBrokenPackages =
nub
@@ -1341,7 +1341,6 @@ type PackageCacheFormat = GhcPkg.GenericUnitInfo
{- Note [Recompute abi-depends]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
Like most fields, `ghc-pkg` relies on who-ever is performing package
registration to fill in fields; this includes the `abi-depends` field present
for the package.
diff --git a/utils/ghc-pkg/ghc.mk b/utils/ghc-pkg/ghc.mk
index e3740723d2..029d0b86e6 100644
--- a/utils/ghc-pkg/ghc.mk
+++ b/utils/ghc-pkg/ghc.mk
@@ -16,7 +16,7 @@
utils/ghc-pkg_PACKAGE = ghc-pkg
# Note [Why build certain utils twice?]
-#
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# We build certain utils twice: once with stage0, and once with stage1.
# Examples are ghc-pkg and hsc2hs.
#
diff --git a/utils/llvm-targets/gen-data-layout.sh b/utils/llvm-targets/gen-data-layout.sh
index 982e178a47..a5dfb0bf5a 100755
--- a/utils/llvm-targets/gen-data-layout.sh
+++ b/utils/llvm-targets/gen-data-layout.sh
@@ -16,7 +16,7 @@
# Add missing targets to the list below to have them included in
# llvm-targets file.
#
-# See Note [LLVM Configuration] in SysTools for the whole story regarding LLVM
+# See Note [LLVM Configuration] in GHC.SysTools for the whole story regarding LLVM
# configuration data.
# Target sets for which to generate the llvm-targets file