summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Klebinger <klebinger.andreas@gmx.at>2022-06-08 16:32:56 +0200
committerAndreas Klebinger <klebinger.andreas@gmx.at>2022-06-08 16:32:56 +0200
commitd7f6fb998126d8b5e8c36841b3c6b660f6a71d1a (patch)
tree97ba71e845b3918841fd58665b856a00b35a066d
parent04209f2a6a49f6cdc116b5cb73ccd1749c90f88b (diff)
downloadhaskell-wip/andreask/doc_dataToTag.tar.gz
Document dataToTag# primopwip/andreask/doc_dataToTag
-rw-r--r--compiler/GHC/Builtin/primops.txt.pp2
1 files changed, 2 insertions, 0 deletions
diff --git a/compiler/GHC/Builtin/primops.txt.pp b/compiler/GHC/Builtin/primops.txt.pp
index 964b8e6d8e..a7c7c3a4cf 100644
--- a/compiler/GHC/Builtin/primops.txt.pp
+++ b/compiler/GHC/Builtin/primops.txt.pp
@@ -3289,6 +3289,8 @@ section "Tag to enum stuff"
primop DataToTagOp "dataToTag#" GenPrimOp
a -> Int# -- Zero-indexed; the first constructor has tag zero
+ { Evaluates the argument and returns the tag of the result.
+ Tags are Zero-indexed; the first constructor has tag zero. }
with
strictness = { \ _arity -> mkClosedDmdSig [evalDmd] topDiv }
-- See Note [dataToTag# magic] in GHC.Core.Opt.ConstantFold