summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoachim Breitner <mail@joachim-breitner.de>2023-01-30 16:06:23 +0100
committerJoachim Breitner <mail@joachim-breitner.de>2023-01-30 16:07:09 +0100
commit8e5fb0e5c05d304b89f690349b4c1279b4baca73 (patch)
tree74f897679850869e5b76f78b17adf003f3dcf06b
parentda468391872f6be286db37a0f016a37f9f362509 (diff)
downloadhaskell-wip/joachim/doc-fixes.tar.gz
Update note at beginning of GHC.Builtin.NAmeswip/joachim/doc-fixes
some things have been renamed since it was written, it seems.
-rw-r--r--compiler/GHC/Builtin/Names.hs16
1 files changed, 9 insertions, 7 deletions
diff --git a/compiler/GHC/Builtin/Names.hs b/compiler/GHC/Builtin/Names.hs
index 3d8a990622..1c26e1aaa9 100644
--- a/compiler/GHC/Builtin/Names.hs
+++ b/compiler/GHC/Builtin/Names.hs
@@ -4,22 +4,23 @@
\section[GHC.Builtin.Names]{Definitions of prelude modules and names}
-Nota Bene: all Names defined in here should come from the base package
+Nota Bene: all Names defined in here should come from the base package,
+the big-num package or (for plugins) the ghc package.
- ModuleNames for prelude modules,
- e.g. pREL_BASE_Name :: ModuleName
+ e.g. pRELUDE_NAME :: ModuleName
- Modules for prelude modules
- e.g. pREL_Base :: Module
+ e.g. pRELUDE :: Module
- Uniques for Ids, DataCons, TyCons and Classes that the compiler
"knows about" in some way
- e.g. intTyConKey :: Unique
+ e.g. orderingTyConKey :: Unique
minusClassOpKey :: Unique
- Names for Ids, DataCons, TyCons and Classes that the compiler
"knows about" in some way
- e.g. intTyConName :: Name
+ e.g. orderingTyConName :: Name
minusName :: Name
One of these Names contains
(a) the module and occurrence name of the thing
@@ -31,8 +32,9 @@ Nota Bene: all Names defined in here should come from the base package
foldrName in the environment.
- RdrNames for Ids, DataCons etc that the compiler may emit into
- generated code (e.g. for deriving). It's not necessary to know
- the uniques for these guys, only their names
+ generated code (e.g. for deriving).
+ e.g. and_RDR :: RdrName
+ It's not necessary to know the uniques for these guys, only their names
Note [Known-key names]