From: Tom Tromey <tom@tromey.com>
Date: Thu, 19 Nov 2015 22:21:14 +0000 (-0700)
Subject: document (lack of) enum handling in libffi
X-Git-Tag: upstream/3.3~334^2
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=f45e9e35700d7c547ba33b02c4186e746dea204a;p=platform%2Fupstream%2Flibffi.git

document (lack of) enum handling in libffi
---

diff --git a/doc/libffi.texi b/doc/libffi.texi
index 0459899..073b8d4 100644
--- a/doc/libffi.texi
+++ b/doc/libffi.texi
@@ -269,7 +269,7 @@ int main()
 * Primitive Types::             Built-in types.
 * Structures::                  Structure types.
 * Size and Alignment::          Size and alignment of types.
-* Arrays and Unions::           Arrays and unions.
+* Arrays Unions Enums::         Arrays, unions, and enumerations.
 * Type Example::                Structure type example.
 * Complex::                     Complex types.
 * Complex Type Example::        Complex type example.
@@ -463,8 +463,8 @@ if (ffi_prep_cif (&cif, desired_abi, 0, desired_type, NULL) == FFI_OK)
   @}
 @end example
 
-@node Arrays and Unions
-@subsection Arrays and Unions
+@node Arrays Unions Enums
+@subsection Arrays, Unions, and Enumerations
 
 @subsubsection Arrays
 
@@ -541,6 +541,16 @@ for (i = 0; union_elements[i]; ++i)
   @}
 @end example
 
+@subsubsection Enumerations
+
+@code{libffi} does not have any special support for C @code{enum}s.
+Although any given @code{enum} is implemented using a specific
+underlying integral type, exactly which type will be used cannot be
+determined by @code{libffi} -- it may depend on the values in the
+enumeration or on compiler flags such as @option{-fshort-enums}.
+@xref{Structures unions enumerations and bit-fields implementation, , , gcc},
+for more information about how GCC handles enumerations.
+
 @node Type Example
 @subsection Type Example