Fix up docs
authorAnthony Green <green@moxielogic.com>
Sat, 2 Nov 2013 21:23:59 +0000 (17:23 -0400)
committerAnthony Green <green@moxielogic.com>
Sat, 2 Nov 2013 21:23:59 +0000 (17:23 -0400)
ChangeLog
doc/libffi.info
doc/libffi.texi

index c8ca936..2c3360e 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2013-11-02  Anthony Green  <green@moxielogic.com>
+
+       * doc/libffi.texi (The Basics): Clarify return value buffer size
+       requirements.  Also, NULL result buffer pointers are no longer
+       supported.
+       * doc/libffi.info: Rebuilt.
+
 2013-11-02  Mischa Jonker  <mjonker@synopsys.com>
 
        * Makefile.am (nodist_libffi_la_SOURCES): Fix build error.
index e57d345..fb02d37 100644 (file)
@@ -156,11 +156,11 @@ function:
      CIF.  CIF must have already been prepared using 'ffi_prep_cif'.
 
      RVALUE is a pointer to a chunk of memory that will hold the result
-     of the function call.  This must be large enough to hold the result
-     and must be suitably aligned; it is the caller's responsibility to
-     ensure this.  If CIF declares that the function returns 'void'
-     (using 'ffi_type_void'), then RVALUE is ignored.  If RVALUE is
-     'NULL', then the return value is discarded.
+     of the function call.  This must be large enough to hold the
+     result, no smaller than the system register size (generally 32 or
+     64 bits), and must be suitably aligned; it is the caller's
+     responsibility to ensure this.  If CIF declares that the function
+     returns 'void' (using 'ffi_type_void'), then RVALUE is ignored.
 
      AVALUES is a vector of 'void *' pointers that point to the memory
      locations holding the argument values for a call.  If CIF declares
@@ -601,15 +601,15 @@ Node: Top\7f682
 Node: Introduction\7f1429
 Node: Using libffi\7f3061
 Node: The Basics\7f3547
-Node: Simple Example\7f7187
-Node: Types\7f8214
-Node: Primitive Types\7f8497
-Node: Structures\7f10318
-Node: Type Example\7f11192
-Node: Multiple ABIs\7f12415
-Node: The Closure API\7f12786
-Node: Closure Example\7f15730
-Node: Missing Features\7f17289
-Node: Index\7f17742
+Node: Simple Example\7f7198
+Node: Types\7f8225
+Node: Primitive Types\7f8508
+Node: Structures\7f10329
+Node: Type Example\7f11203
+Node: Multiple ABIs\7f12426
+Node: The Closure API\7f12797
+Node: Closure Example\7f15741
+Node: Missing Features\7f17300
+Node: Index\7f17753
 \1f
 End Tag Table
index 5c0552b..eca11dc 100644 (file)
@@ -184,11 +184,11 @@ This calls the function @var{fn} according to the description given in
 
 @var{rvalue} is a pointer to a chunk of memory that will hold the
 result of the function call.  This must be large enough to hold the
-result and must be suitably aligned; it is the caller's responsibility
+result, no smaller than the system register size (generally 32 or 64
+bits), and must be suitably aligned; it is the caller's responsibility
 to ensure this.  If @var{cif} declares that the function returns
 @code{void} (using @code{ffi_type_void}), then @var{rvalue} is
-ignored.  If @var{rvalue} is @samp{NULL}, then the return value is
-discarded.
+ignored.
 
 @var{avalues} is a vector of @code{void *} pointers that point to the
 memory locations holding the argument values for a call.  If @var{cif}