Browse Source

FFI: Clarify docs wrt. string initializers for byte arrays.

Mike Pall 14 years ago
parent
commit
e613cb7695
1 changed files with 6 additions and 2 deletions
  1. 6 2
      doc/ext_ffi_semantics.html

+ 6 - 2
doc/ext_ffi_semantics.html

@@ -461,8 +461,8 @@ when a single initializer is given. Otherwise they are treated like
 regular arrays.</li>
 
 <li>Aggregate types (arrays and structs) accept either a single
-<a href="#init_table">table initializer</a> or a flat list of initializers.
-Byte arrays can be initialized with a Lua string, too.</li>
+<a href="#init_table">table initializer</a> or a flat list of
+initializers.</li>
 
 <li>The elements of an array are initialized, starting at index zero.
 If a single initializer is given for an array, it's repeated for all
@@ -470,6 +470,10 @@ remaining elements. This doesn't happen if two or more initializers
 are given: all remaining uninitialized elements are filled with zero
 bytes.</li>
 
+<li>Byte arrays may also be initialized with a Lua string. This copies
+the whole string plus a terminating zero-byte. The copy stops early only
+if the array has a known, fixed size.</li>
+
 <li>The fields of a <tt>struct</tt> are initialized in the order of
 their declaration. Uninitialized fields are filled with zero
 bytes.</li>