[commit: ghc] master: Document unpackClosure# primop (5ebcb3a)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/ghc

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/5ebcb3acaae63886d55f379d7e48437ac264a169/ghc

>---------------------------------------------------------------

commit 5ebcb3acaae63886d55f379d7e48437ac264a169
Author: Ömer Sinan Ağacan <omeragacan at gmail.com>
Date:   Fri Oct 28 15:36:55 2016 -0400

    Document unpackClosure# primop


>---------------------------------------------------------------

5ebcb3acaae63886d55f379d7e48437ac264a169
 compiler/prelude/primops.txt.pp | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/compiler/prelude/primops.txt.pp b/compiler/prelude/primops.txt.pp
index a38dd57..49f78fa 100644
--- a/compiler/prelude/primops.txt.pp
+++ b/compiler/prelude/primops.txt.pp
@@ -2631,6 +2631,11 @@ primop  NewBCOOp "newBCO#" GenPrimOp
 
 primop  UnpackClosureOp "unpackClosure#" GenPrimOp
    a -> (# Addr#, Array# b, ByteArray# #)
+   { {\tt unpackClosure\# closure} copies non-pointers and pointers in the
+     payload of the given closure into two new arrays, and returns a pointer to
+     the first word of the closure's info table, a pointer array for the
+     pointers in the payload, and a non-pointer array for the non-pointers in
+     the payload. }
    with
    out_of_line = True