summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Klebinger <klebinger.andreas@gmx.at>2021-07-30 16:51:07 +0200
committerAndreas Klebinger <klebinger.andreas@gmx.at>2021-07-30 16:51:07 +0200
commitcedd5bf8e3fbdf89b76f99e11d564245f7dee2ea (patch)
tree08902a21759ac191ec816a8a2678f19102afb8ea
parent54d6b20192fe6fc244248c7766533a768c591bae (diff)
downloadhaskell-wip/andreask/hash_doc.tar.gz
Improve documentation for HscTypes.usg_mod_hashwip/andreask/hash_doc
-rw-r--r--compiler/GHC/Unit/Module/Deps.hs7
1 files changed, 5 insertions, 2 deletions
diff --git a/compiler/GHC/Unit/Module/Deps.hs b/compiler/GHC/Unit/Module/Deps.hs
index 2cafbbdcd4..9832383d8a 100644
--- a/compiler/GHC/Unit/Module/Deps.hs
+++ b/compiler/GHC/Unit/Module/Deps.hs
@@ -110,7 +110,7 @@ data Usage
usg_mod :: Module,
-- ^ External package module depended on
usg_mod_hash :: Fingerprint,
- -- ^ Cached module fingerprint
+ -- ^ Cached module ABI fingerprint (corresponds to mi_mod_hash)
usg_safe :: IsSafeImport
-- ^ Was this module imported as a safe import
}
@@ -119,7 +119,10 @@ data Usage
usg_mod_name :: ModuleName,
-- ^ Name of the module
usg_mod_hash :: Fingerprint,
- -- ^ Cached module fingerprint
+ -- ^ Cached module ABI fingerprint (corresponds to mi_mod_hash).
+ -- This may be out dated after recompilation was avoided, but is
+ -- still used as a fast initial check for change during
+ -- recompilation avoidance.
usg_entities :: [(OccName,Fingerprint)],
-- ^ Entities we depend on, sorted by occurrence name and fingerprinted.
-- NB: usages are for parent names only, e.g. type constructors