diff options
| author | Takenobu Tani <takenobu.hs@gmail.com> | 2020-06-09 22:59:05 +0900 |
|---|---|---|
| committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2020-06-25 03:54:44 -0400 |
| commit | 1eb997a84669f158de9dd16a9e54d279cec22293 (patch) | |
| tree | 0c917f73815f01bdb4a3055f6eb173429160a723 /compiler/GHC/Runtime | |
| parent | c7dd6da7e066872a949be7c914cc700182307cd2 (diff) | |
| download | haskell-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/Runtime')
| -rw-r--r-- | compiler/GHC/Runtime/Heap/Layout.hs | 8 | ||||
| -rw-r--r-- | compiler/GHC/Runtime/Linker/Types.hs | 4 |
2 files changed, 6 insertions, 6 deletions
diff --git a/compiler/GHC/Runtime/Heap/Layout.hs b/compiler/GHC/Runtime/Heap/Layout.hs index 4f32cec7c4..4f43c13344 100644 --- a/compiler/GHC/Runtime/Heap/Layout.hs +++ b/compiler/GHC/Runtime/Heap/Layout.hs @@ -148,7 +148,7 @@ halfWordSizeInBits platform = platformWordSizeInBits platform `div` 2 -} -- | A description of the layout of a closure. Corresponds directly --- to the closure types in includes/rts/storage/ClosureTypes.h. +-- to the closure types in includes\/rts\/storage\/ClosureTypes.h. data SMRep = HeapRep -- GC routines consult sizes in info tbl IsStatic @@ -173,7 +173,7 @@ data SMRep Int -- type tags, so this form lets us override the default SMRep -- tag for an SMRep. --- | True <=> This is a static closure. Affects how we garbage-collect it. +-- | True \<=> This is a static closure. Affects how we garbage-collect it. -- Static closure have an extra static link field at the end. -- Constructors do not have a static variant; see Note [static constructors] type IsStatic = Bool @@ -274,12 +274,12 @@ isStaticNoCafCon _ = False fixedHdrSize :: DynFlags -> ByteOff fixedHdrSize dflags = wordsToBytes (targetPlatform dflags) (fixedHdrSizeW dflags) --- | Size of a closure header (StgHeader in includes/rts/storage/Closures.h) +-- | Size of a closure header (StgHeader in includes\/rts\/storage\/Closures.h) fixedHdrSizeW :: DynFlags -> WordOff fixedHdrSizeW dflags = sTD_HDR_SIZE dflags + profHdrSize dflags -- | Size of the profiling part of a closure header --- (StgProfHeader in includes/rts/storage/Closures.h) +-- (StgProfHeader in includes\/rts\/storage\/Closures.h) profHdrSize :: DynFlags -> WordOff profHdrSize dflags | gopt Opt_SccProfilingOn dflags = pROF_HDR_SIZE dflags diff --git a/compiler/GHC/Runtime/Linker/Types.hs b/compiler/GHC/Runtime/Linker/Types.hs index d4539712e2..429a658042 100644 --- a/compiler/GHC/Runtime/Linker/Types.hs +++ b/compiler/GHC/Runtime/Linker/Types.hs @@ -91,7 +91,7 @@ data Unlinked -- carries some static pointer table entries which -- should be loaded along with the BCOs. -- See Note [Grant plan for static forms] in - -- GHC.Iface.Tidy.StaticPtrTable. + -- "GHC.Iface.Tidy.StaticPtrTable". instance Outputable Unlinked where ppr (DotO path) = text "DotO" <+> text path @@ -100,7 +100,7 @@ instance Outputable Unlinked where ppr (BCOs bcos spt) = text "BCOs" <+> ppr bcos <+> ppr spt -- | An entry to be inserted into a module's static pointer table. --- See Note [Grand plan for static forms] in GHC.Iface.Tidy.StaticPtrTable. +-- See Note [Grand plan for static forms] in "GHC.Iface.Tidy.StaticPtrTable". data SptEntry = SptEntry Id Fingerprint instance Outputable SptEntry where |