* intrinsic.texi (Transfer): Improve documentation.

From-SVN: r124234

diff --git a/gcc/fortran/ChangeLog b/gcc/fortran/ChangeLog
index 792817cff44cdc68f7f8b3b1bb8d263ff07df367..0266e54da4faec20140b6be355275e0d4c155caa 100644 (file)
--- a/gcc/fortran/ChangeLog
+++ b/gcc/fortran/ChangeLog
@@ -1,3 +1,7 @@
+2007-04-27  Brooks Moses  <brooks.moses@codesourcery.com>
+
+       * intrinsic.texi (Transfer): Improve documentation.
+
 2007-04-27  Brooks Moses  <brooks.moses@codesourcery.com>
 
        * gfortran.texi (Option Index): Add @samp as needed.

diff --git a/gcc/fortran/intrinsic.texi b/gcc/fortran/intrinsic.texi
index bb2d6e20f77174a4acd9a6a6da0bec0d6f9fcabc..011d2b844de135d881ed191ca2d74d7ac754148a 100644 (file)
--- a/gcc/fortran/intrinsic.texi
+++ b/gcc/fortran/intrinsic.texi
@@ -9527,10 +9527,12 @@ See @code{HUGE} for an example.
 
 @table @asis
 @item @emph{Description}:
-Interprets the bit pattern of @var{SOURCE} as a variable of the 
-same type and type parameters as @var{MOLD}.
+Interprets the bitwise representation of @var{SOURCE} in memory as if it
+is the representation of a variable or array of the same type and type
+parameters as @var{MOLD}.
 
-This is also known as @emph{casting} one type to another.
+This is approximately equivalent to the C concept of @emph{casting} one
+type to another.
 
 @item @emph{Standard}:
 F95 and later
@@ -9545,13 +9547,29 @@ Transformational function
 @multitable @columnfractions .15 .70
 @item @var{SOURCE} @tab Shall be a scalar or an array of any type.
 @item @var{MOLD}   @tab Shall be a scalar or an array of any type.
-@item @var{SIZE}   @tab (Optional) shall be a scalar and of type 
+@item @var{SIZE}   @tab (Optional) shall be a scalar of type 
 @code{INTEGER}.
 @end multitable
 
 @item @emph{Return value}:
-The result has the same type as @var{MOLD} with the bit level 
-representation of @var{SOURCE}.
+The result has the same type as @var{MOLD}, with the bit level
+representation of @var{SOURCE}.  If @var{SIZE} is present, the result is
+a one-dimensional array of length @var{SIZE}.  If @var{SIZE} is absent
+but @var{MOLD} is an array (of any size or shape), the result is a one-
+dimensional array of the minimum length needed to contain the entirety
+of the bitwise representation of @var{SOURCE}.   If @var{SIZE} is absent
+and @var{MOLD} is a scalar, the result is a scalar.
+
+If the bitwise representation of the result is longer than that of
+@var{SOURCE}, then the leading bits of the result correspond to those of
+@var{SOURCE} and any trailing bits are filled arbitrarily.
+
+When the resulting bit representation does not correspond to a valid
+representation of a variable of the same type as @var{MOLD}, the results
+are undefined, and subsequent operations on the result cannot be
+guaranteed to produce sensible behavior.  For example, it is possible to
+create @code{LOGICAL} variables for which @code{@var{VAR}} and
+@code{.NOT.@var{VAR}} both appear to be true.
 
 @item @emph{Example}:
 @smallexample