Commit 96de8098 authored by Ben Gamari's avatar Ben Gamari
Browse files

Fix primops documentation syntax

parent 4cd008b6
...@@ -2447,27 +2447,27 @@ section "Bytecode operations" ...@@ -2447,27 +2447,27 @@ section "Bytecode operations"
------------------------------------------------------------------------ ------------------------------------------------------------------------
primtype BCO# primtype BCO#
{Primitive bytecode type.} { Primitive bytecode type. }
primop AddrToAnyOp "addrToAny#" GenPrimOp primop AddrToAnyOp "addrToAny#" GenPrimOp
Addr# -> (# a #) Addr# -> (# a #)
{Convert an {\tt Addr\#} to a followable Any type.} { Convert an {\tt Addr\#} to a followable Any type. }
with with
code_size = 0 code_size = 0
primop MkApUpd0_Op "mkApUpd0#" GenPrimOp primop MkApUpd0_Op "mkApUpd0#" GenPrimOp
BCO# -> (# a #) BCO# -> (# a #)
{Wrap a BCO in a {\tt AP_UPD} thunk which will be updated with the vaule of { Wrap a BCO in a {\tt AP_UPD} thunk which will be updated with the vaule of
the BCO when evaluated.} the BCO when evaluated. }
with with
out_of_line = True out_of_line = True
primop NewBCOOp "newBCO#" GenPrimOp primop NewBCOOp "newBCO#" GenPrimOp
ByteArray# -> ByteArray# -> Array# a -> Int# -> ByteArray# -> State# s -> (# State# s, BCO# #) ByteArray# -> ByteArray# -> Array# a -> Int# -> ByteArray# -> State# s -> (# State# s, BCO# #)
{{\tt newBCO\#} instrs lits ptrs arity bitmap} creates a new bytecode object. The { {\tt newBCO\# instrs lits ptrs arity bitmap} creates a new bytecode object. The
resulting object encodes a function of the given arity with the instructions resulting object encodes a function of the given arity with the instructions
encoded in {\tt instrs}, and a static reference table usage bitmap given by encoded in {\tt instrs}, and a static reference table usage bitmap given by
{\tt bitmap}.} {\tt bitmap}. }
with with
has_side_effects = True has_side_effects = True
out_of_line = True out_of_line = True
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment