summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Klebinger <klebinger.andreas@gmx.at>2021-07-30 16:51:07 +0200
committerMarge Bot <ben+marge-bot@smart-cactus.org>2021-08-03 10:17:29 -0400
commitbd2874000ffa72f9d1f98b2223a37e6cc3c78567 (patch)
treec0ae44c649e2fcb05659e191e34e4ad023d704b5
parentc0e66524077019bbb6839d46e97d7b1e72c57685 (diff)
downloadhaskell-bd2874000ffa72f9d1f98b2223a37e6cc3c78567.tar.gz
Improve documentation for HscTypes.usg_mod_hash
-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