[Git][ghc/ghc][master] Update note at beginning of GHC.Builtin.NAmes

[Marge Bot (@marge-bot)]

Marge Bot pushed to branch master at Glasgow Haskell Compiler / GHC


Commits:
085a6db6 by Joachim Breitner at 2023-01-31T07:55:05-05:00
Update note at beginning of GHC.Builtin.NAmes

some things have been renamed since it was written, it seems.

- - - - -


1 changed file:

- compiler/GHC/Builtin/Names.hs


Changes:

=====================================
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]



View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/085a6db690ababae5d7b6a73f13a1f2f24aa9417

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/085a6db690ababae5d7b6a73f13a1f2f24aa9417
You're receiving this email because of your account on gitlab.haskell.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-commits/attachments/20230131/3fded447/attachment-0001.html>