summary refs log tree commit diff stats
path: root/doc/manual.txt
diff options
context:
space:
mode:
authorAraq <rumpf_a@web.de>2014-03-22 02:52:33 +0100
committerAraq <rumpf_a@web.de>2014-03-22 02:52:33 +0100
commit5aac789e0e183a1a2193bd7615de0b4a29f4708c (patch)
tree6bf8e890cabd98705eabb6d5dfc48b928adc106c /doc/manual.txt
parente53fc91282bc8a5dabc4f12e041fa6ce5400c007 (diff)
parent13d26dc53db455ef07feb315871a7fceee5f7a01 (diff)
downloadNim-5aac789e0e183a1a2193bd7615de0b4a29f4708c.tar.gz
Merge branch 'devel' of https://github.com/Araq/Nimrod into devel
Diffstat (limited to 'doc/manual.txt')
-rw-r--r--doc/manual.txt10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/manual.txt b/doc/manual.txt
index a9e6aebb4..5c4aa2c17 100644
--- a/doc/manual.txt
+++ b/doc/manual.txt
@@ -5395,6 +5395,16 @@ checked.
 **Future directions**: GC'ed memory should be allowed in unions and the GC
 should scan unions conservatively.
 
+Packed pragma
+-------------
+The `packed`:idx: pragma can be applied to any ``object`` type. It ensures 
+that the fields of an object are packed back-to-back in memory. It is useful 
+to store packets or messages from/to network or hardware drivers, and for 
+interoperability with C. Combining packed pragma with inheritance is not 
+defined, and it should not be used with GC'ed memory (ref's).  
+
+**Future directions**: Using GC'ed memory in packed pragma will result in 
+compile-time error. Usage with inheritance should be defined and documented.
 
 Unchecked pragma
 ----------------