summaryrefslogtreecommitdiff
path: root/compiler/GHC/Utils
diff options
context:
space:
mode:
authorTakenobu Tani <takenobu.hs@gmail.com>2020-06-09 22:59:05 +0900
committerMarge Bot <ben+marge-bot@smart-cactus.org>2020-06-25 03:54:44 -0400
commit1eb997a84669f158de9dd16a9e54d279cec22293 (patch)
tree0c917f73815f01bdb4a3055f6eb173429160a723 /compiler/GHC/Utils
parentc7dd6da7e066872a949be7c914cc700182307cd2 (diff)
downloadhaskell-1eb997a84669f158de9dd16a9e54d279cec22293.tar.gz
Clean up haddock hyperlinks of GHC.* (part2)
This updates haddock comments only. This patch focuses to update for hyperlinks in GHC API's haddock comments, because broken links especially discourage newcomers. This includes the following hierarchies: - GHC.Iface.* - GHC.Llvm.* - GHC.Rename.* - GHC.Tc.* - GHC.HsToCore.* - GHC.StgToCmm.* - GHC.CmmToAsm.* - GHC.Runtime.* - GHC.Unit.* - GHC.Utils.* - GHC.SysTools.*
Diffstat (limited to 'compiler/GHC/Utils')
-rw-r--r--compiler/GHC/Utils/Asm.hs2
-rw-r--r--compiler/GHC/Utils/Binary.hs2
-rw-r--r--compiler/GHC/Utils/Error.hs6
-rw-r--r--compiler/GHC/Utils/Outputable.hs2
-rw-r--r--compiler/GHC/Utils/Panic.hs8
-rw-r--r--compiler/GHC/Utils/Panic/Plain.hs16
-rw-r--r--compiler/GHC/Utils/Ppr.hs2
7 files changed, 19 insertions, 19 deletions
diff --git a/compiler/GHC/Utils/Asm.hs b/compiler/GHC/Utils/Asm.hs
index 5b8b209f5e..2841ad3efa 100644
--- a/compiler/GHC/Utils/Asm.hs
+++ b/compiler/GHC/Utils/Asm.hs
@@ -1,7 +1,7 @@
-- | Various utilities used in generating assembler.
--
-- These are used not only by the native code generator, but also by the
--- GHC.Driver.Pipeline
+-- "GHC.Driver.Pipeline"
module GHC.Utils.Asm
( sectionType
) where
diff --git a/compiler/GHC/Utils/Binary.hs b/compiler/GHC/Utils/Binary.hs
index 10810ba96a..d95041665a 100644
--- a/compiler/GHC/Utils/Binary.hs
+++ b/compiler/GHC/Utils/Binary.hs
@@ -1089,7 +1089,7 @@ lazyGet bh = do
-- These two settings have different needs while serializing Names:
--
-- * Names in interface files are serialized via a symbol table (see Note
--- [Symbol table representation of names] in GHC.Iface.Binary).
+-- [Symbol table representation of names] in "GHC.Iface.Binary").
--
-- * During fingerprinting a binding Name is serialized as the OccName and a
-- non-binding Name is serialized as the fingerprint of the thing they
diff --git a/compiler/GHC/Utils/Error.hs b/compiler/GHC/Utils/Error.hs
index 3bb9aa7329..4c72c052d7 100644
--- a/compiler/GHC/Utils/Error.hs
+++ b/compiler/GHC/Utils/Error.hs
@@ -170,16 +170,16 @@ data Severity
| SevDump
-- ^ Log message intended for compiler developers
- -- No file/line/column stuff
+ -- No file\/line\/column stuff
| SevInfo
-- ^ Log messages intended for end users.
- -- No file/line/column stuff.
+ -- No file\/line\/column stuff.
| SevWarning
| SevError
-- ^ SevWarning and SevError are used for warnings and errors
- -- o The message has a file/line/column heading,
+ -- o The message has a file\/line\/column heading,
-- plus "warning:" or "error:",
-- added by mkLocMessags
-- o Output is intended for end users
diff --git a/compiler/GHC/Utils/Outputable.hs b/compiler/GHC/Utils/Outputable.hs
index 151800a30b..b3d1772076 100644
--- a/compiler/GHC/Utils/Outputable.hs
+++ b/compiler/GHC/Utils/Outputable.hs
@@ -958,7 +958,7 @@ instance Outputable Extension where
-- | 'BindingSite' is used to tell the thing that prints binder what
-- language construct is binding the identifier. This can be used
-- to decide how much info to print.
--- Also see Note [Binding-site specific printing] in GHC.Core.Ppr
+-- Also see Note [Binding-site specific printing] in "GHC.Core.Ppr"
data BindingSite
= LambdaBind -- ^ The x in (\x. e)
| CaseBind -- ^ The x in case scrut of x { (y,z) -> ... }
diff --git a/compiler/GHC/Utils/Panic.hs b/compiler/GHC/Utils/Panic.hs
index 9d960644b6..551e9337de 100644
--- a/compiler/GHC/Utils/Panic.hs
+++ b/compiler/GHC/Utils/Panic.hs
@@ -56,12 +56,12 @@ import System.Mem.Weak ( deRefWeak )
-- error messages all take the form:
--
-- @
--- <location>: <error>
+-- \<location>: \<error>
-- @
--
-- If the location is on the command line, or in GHC itself, then
--- <location>="ghc". All of the error types below correspond to
--- a <location> of "ghc", except for ProgramError (where the string is
+-- \<location>="ghc". All of the error types below correspond to
+-- a \<location> of "ghc", except for ProgramError (where the string is
-- assumed to contain a location already, so we don't print one).
data GhcException
@@ -128,7 +128,7 @@ safeShowException e = do
-- | Append a description of the given exception to this string.
--
--- Note that this uses 'DynFlags.unsafeGlobalDynFlags', which may have some
+-- Note that this uses 'GHC.Driver.Session.unsafeGlobalDynFlags', which may have some
-- uninitialized fields if invoked before 'GHC.initGhcMonad' has been called.
-- If the error message to be printed includes a pretty-printer document
-- which forces one of these fields this call may bottom.
diff --git a/compiler/GHC/Utils/Panic/Plain.hs b/compiler/GHC/Utils/Panic/Plain.hs
index 8e4aed5046..8e54f81cde 100644
--- a/compiler/GHC/Utils/Panic/Plain.hs
+++ b/compiler/GHC/Utils/Panic/Plain.hs
@@ -1,13 +1,13 @@
{-# LANGUAGE CPP, ScopedTypeVariables, LambdaCase #-}
-- | Defines a simple exception type and utilities to throw it. The
--- 'PlainGhcException' type is a subset of the 'Panic.GhcException'
+-- 'PlainGhcException' type is a subset of the 'GHC.Utils.Panic.GhcException'
-- type. It omits the exception constructors that involve
--- pretty-printing via 'Outputable.SDoc'.
+-- pretty-printing via 'GHC.Utils.Outputable.SDoc'.
--
-- There are two reasons for this:
--
--- 1. To avoid import cycles / use of boot files. "Outputable" has
+-- 1. To avoid import cycles / use of boot files. "GHC.Utils.Outputable" has
-- many transitive dependencies. To throw exceptions from these
-- modules, the functions here can be used without introducing import
-- cycles.
@@ -34,14 +34,14 @@ import GHC.Prelude
import System.Environment
import System.IO.Unsafe
--- | This type is very similar to 'Panic.GhcException', but it omits
+-- | This type is very similar to 'GHC.Utils.Panic.GhcException', but it omits
-- the constructors that involve pretty-printing via
--- 'Outputable.SDoc'. Due to the implementation of 'fromException'
--- for 'Panic.GhcException', this type can be caught as a
--- 'Panic.GhcException'.
+-- 'GHC.Utils.Outputable.SDoc'. Due to the implementation of 'fromException'
+-- for 'GHC.Utils.Panic.GhcException', this type can be caught as a
+-- 'GHC.Utils.Panic.GhcException'.
--
-- Note that this should only be used for throwing exceptions, not for
--- catching, as 'Panic.GhcException' will not be converted to this
+-- catching, as 'GHC.Utils.Panic.GhcException' will not be converted to this
-- type when catching.
data PlainGhcException
-- | Some other fatal signal (SIGHUP,SIGTERM)
diff --git a/compiler/GHC/Utils/Ppr.hs b/compiler/GHC/Utils/Ppr.hs
index 96e1328ff7..3fa84850b8 100644
--- a/compiler/GHC/Utils/Ppr.hs
+++ b/compiler/GHC/Utils/Ppr.hs
@@ -16,7 +16,7 @@
-- Based on /The Design of a Pretty-printing Library/
-- in Advanced Functional Programming,
-- Johan Jeuring and Erik Meijer (eds), LNCS 925
--- <http://www.cs.chalmers.se/~rjmh/Papers/pretty.ps>
+-- <http://www.cse.chalmers.se/~rjmh/Papers/pretty.ps>
--
-----------------------------------------------------------------------------