libgomp: Add documentation for omp_fulfill_event runtime function

2021-01-25  Kwok Cheung Yeung  <kcy@codesourcery.com>

	libgomp/
	* libgomp.texi (omp_fulfill_event): New entry.
This commit is contained in:
Kwok Cheung Yeung 2021-01-25 09:57:38 -08:00
parent d9ad3b422f
commit 0194e2f02d
1 changed files with 34 additions and 0 deletions

View File

@ -210,6 +210,10 @@ Portable, thread-based, wall clock timer.
* omp_get_wtick:: Get timer precision.
* omp_get_wtime:: Elapsed wall clock time.
Support for event objects.
* omp_fulfill_event:: Fulfill and destroy an OpenMP event.
@end menu
@ -1401,6 +1405,36 @@ guaranteed not to change during the execution of the program.
@node omp_fulfill_event
@section @code{omp_fulfill_event} -- Fulfill and destroy an OpenMP event
@table @asis
@item @emph{Description}:
Fulfill the event associated with the event handle argument. Currently, it
is only used to fulfill events generated by detach clauses on task
constructs - the effect of fulfilling the event is to allow the task to
complete.
The result of calling @code{omp_fulfill_event} with an event handle other
than that generated by a detach clause is undefined. Calling it with an
event handle that has already been fulfilled is also undefined.
@item @emph{C/C++}:
@multitable @columnfractions .20 .80
@item @emph{Prototype}: @tab @code{void omp_fulfill_event(omp_event_handle_t event);}
@end multitable
@item @emph{Fortran}:
@multitable @columnfractions .20 .80
@item @emph{Interface}: @tab @code{subroutine omp_fulfill_event(event)}
@item @tab @code{integer (kind=omp_event_handle_kind) :: event}
@end multitable
@item @emph{Reference}:
@uref{https://www.openmp.org, OpenMP specification v5.0}, Section 3.5.1.
@end table
@c ---------------------------------------------------------------------
@c OpenMP Environment Variables
@c ---------------------------------------------------------------------