Fix up docs

This commit is contained in:
Anthony Green
2013-11-02 17:23:59 -04:00
parent 0217717685
commit cf6bf9818e
3 changed files with 25 additions and 18 deletions

View File

@@ -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.

View 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: Top682
Node: Introduction1429
Node: Using libffi3061
Node: The Basics3547
Node: Simple Example7187
Node: Types8214
Node: Primitive Types8497
Node: Structures10318
Node: Type Example11192
Node: Multiple ABIs12415
Node: The Closure API12786
Node: Closure Example15730
Node: Missing Features17289
Node: Index17742
Node: Simple Example7198
Node: Types8225
Node: Primitive Types8508
Node: Structures10329
Node: Type Example11203
Node: Multiple ABIs12426
Node: The Closure API12797
Node: Closure Example15741
Node: Missing Features17300
Node: Index17753

End Tag Table

View 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}