This is the mail archive of the
gcc-patches@gcc.gnu.org
mailing list for the GCC project.
[patch, fortran, docs, committed] Document function forms of some intrinsics
- From: Brooks Moses <brooks dot moses at codesourcery dot com>
- To: gcc-patches at gcc dot gnu dot org
- Cc: fortran at gcc dot gnu dot org
- Date: Thu, 08 Mar 2007 14:58:55 -0800
- Subject: [patch, fortran, docs, committed] Document function forms of some intrinsics
Some GNU-extension intrinsics have both function and subroutine forms,
but we have only documented the subroutine form. This patch also
documents the function form.
Tested with "make pdf" and "make info", committed to trunk under blanket
approval from Steve Kargl; will commit to 4.2 momentarily.
----------------------------------------------------------------
2007-03-08 Brooks Moses <brooks.moses@codesourcery.com>
* intrinsic.texi: (LINK) Document function form.
(RENAME): Likewise.
(SYMLNK): Likewise.
(SYSTEM): Likewise.
(UNLINK): Likewise.
----------------------------------------------------------------
- Brooks
Index: intrinsic.texi
===================================================================
--- intrinsic.texi (revision 122726)
+++ intrinsic.texi (working copy)
@@ -5635,14 +5635,20 @@
contains 0 on success or a nonzero error code upon return; see
@code{link(2)}.
+This intrinsic is provided in both subroutine and function forms;
+however, only one form can be used in any given program unit.
+
@item @emph{Standard}:
GNU extension
@item @emph{Class}:
-Subroutine
+Subroutine, non-elemental function
@item @emph{Syntax}:
-@code{CALL LINK(PATH1, PATH2 [, STATUS])}
+@multitable @columnfractions .80
+@item @code{CALL LINK(PATH1, PATH2 [, STATUS])}
+@item @code{STATUS = LINK(PATH1, PATH2)}
+@end multitable
@item @emph{Arguments}:
@multitable @columnfractions .15 .70
@@ -7511,14 +7517,20 @@
contains 0 on success or a nonzero error code upon return; see
@code{rename(2)}.
+This intrinsic is provided in both subroutine and function forms;
+however, only one form can be used in any given program unit.
+
@item @emph{Standard}:
GNU extension
@item @emph{Class}:
-Subroutine
+Subroutine, non-elemental function
@item @emph{Syntax}:
-@code{CALL RENAME(PATH1, PATH2 [, STATUS])}
+@multitable @columnfractions .80
+@item @code{CALL RENAME(PATH1, PATH2 [, STATUS])}
+@item @code{STATUS = RENAME(PATH1, PATH2)}
+@end multitable
@item @emph{Arguments}:
@multitable @columnfractions .15 .70
@@ -8519,14 +8531,20 @@
@code{symlink(2)}. If the system does not supply @code{symlink(2)},
@code{ENOSYS} is returned.
+This intrinsic is provided in both subroutine and function forms;
+however, only one form can be used in any given program unit.
+
@item @emph{Standard}:
GNU extension
@item @emph{Class}:
-Subroutine
+Subroutine, non-elemental function
@item @emph{Syntax}:
-@code{CALL SYMLNK(PATH1, PATH2 [, STATUS])}
+@multitable @columnfractions .80
+@item @code{CALL SYMLNK(PATH1, PATH2 [, STATUS])}
+@item @code{STATUS = SYMLNK(PATH1, PATH2)}
+@end multitable
@item @emph{Arguments}:
@multitable @columnfractions .15 .70
@@ -8554,14 +8572,20 @@
Note that which shell is used to invoke the command is system-dependent
and environment-dependent.
+This intrinsic is provided in both subroutine and function forms;
+however, only one form can be used in any given program unit.
+
@item @emph{Standard}:
GNU extension
@item @emph{Class}:
-Subroutine
+Subroutine, non-elemental function
@item @emph{Syntax}:
-@code{CALL SYSTEM(COMMAND [, STATUS])}
+@multitable @columnfractions .80
+@item @code{CALL SYSTEM(COMMAND [, STATUS])}
+@item @code{STATUS = SYSTEM(COMMAND)}
+@end multitable
@item @emph{Arguments}:
@multitable @columnfractions .15 .70
@@ -9007,14 +9031,20 @@
supplied, it contains 0 on success or a nonzero error code upon return;
see @code{unlink(2)}.
+This intrinsic is provided in both subroutine and function forms;
+however, only one form can be used in any given program unit.
+
@item @emph{Standard}:
GNU extension
@item @emph{Class}:
-Subroutine
+Subroutine, non-elemental function
@item @emph{Syntax}:
-@code{CALL UNLINK(PATH [, STATUS])}
+@multitable @columnfractions .80
+@item @code{CALL UNLINK(PATH [, STATUS])}
+@item @code{STATUS = UNLINK(PATH)}
+@end multitable
@item @emph{Arguments}:
@multitable @columnfractions .15 .70