[gomp4.1] document omp_get_max_task_priority and OMP_MAX_TASK_PRIORITY

Aldy Hernandez aldyh@redhat.com
Thu Jun 25 21:20:00 GMT 2015


While looking around the OMP4.1 party, I noticed that 
OMP_MAX_TASK_PRIORITY and friends are not documented in the library.

Attached is a patch adding said support.  (Don't look at me, the whole 
documentation layout was ugly when I got here.)

Tested by building libgomp.

OK for branch?
-------------- next part --------------
commit 98e12d99f2e83cd235af0aebe6435a25c69e3137
Author: Aldy Hernandez <aldyh@redhat.com>
Date:   Thu Jun 25 14:07:26 2015 -0700

    	* libgomp.texi: Document omp_get_max_task_priority and
    	OMP_MAX_TASK_PRIORITY.

diff --git a/libgomp/libgomp.texi b/libgomp/libgomp.texi
index f3a138e..79e1b22 100644
--- a/libgomp/libgomp.texi
+++ b/libgomp/libgomp.texi
@@ -155,6 +155,7 @@ linkage, and do not throw exceptions.
 * omp_get_dynamic::             Dynamic teams setting
 * omp_get_level::               Number of parallel regions
 * omp_get_max_active_levels::   Maximum number of active regions
+* omp_get_max_task_priority::   Maximum task priority value that can be set
 * omp_get_max_threads::         Maximum number of threads of parallel region
 * omp_get_nested::              Nested parallel regions
 * omp_get_num_devices::         Number of target devices
@@ -388,6 +389,27 @@ This function obtains the maximum allowed number of nested, active parallel regi
 @end table
 
 
+@node omp_get_max_task_priority
+@section @code{omp_get_max_task_priority} -- Maximum priority value
+that can be set for tasks.
+@table @asis
+@item @emph{Description}:
+This function obtains the maximum allowed priority number for tasks.
+
+@item @emph{C/C++}
+@multitable @columnfractions .20 .80
+@item @emph{Prototype}: @tab @code{int omp_get_max_task_priority(void);}
+@end multitable
+
+@item @emph{Fortran}:
+@multitable @columnfractions .20 .80
+@item @emph{Interface}: @tab @code{integer function omp_get_max_task_priority()}
+@end multitable
+
+@item @emph{Reference}:
+@uref{http://www.openmp.org/, OpenMP specification v4.1}, Section 3.2.29.
+@end table
+
 
 @node omp_get_max_threads
 @section @code{omp_get_max_threads} -- Maximum number of threads of parallel region
@@ -1311,6 +1333,7 @@ beginning with @env{GOMP_} are GNU extensions.
 * OMP_DEFAULT_DEVICE::    Set the device used in target regions
 * OMP_DYNAMIC::           Dynamic adjustment of threads
 * OMP_MAX_ACTIVE_LEVELS:: Set the maximum number of nested parallel regions
+* OMP_MAX_TASK_PRIORITY:: Set the maximum task priority value
 * OMP_NESTED::            Nested parallel regions
 * OMP_NUM_THREADS::       Specifies the number of threads to use
 * OMP_PROC_BIND::         Whether theads may be moved between CPUs
@@ -1419,6 +1442,25 @@ If undefined, the number of active levels is unlimited.
 
 
 
+@node OMP_MAX_TASK_PRIORITY
+@section @env{OMP_MAX_TASK_PRIORITY} -- Set the maximum priority
+number that can be set for a task.
+@cindex Environment Variable
+@table @asis
+@item @emph{Description}:
+Specifies the initial value for the maximum priority value that can be
+set for a task.  The value of this variable shall be a positive
+integer.  If undefined, the default priority is 0.
+
+@item @emph{See also}:
+@ref{omp_get_max_task_priority}
+
+@item @emph{Reference}: 
+@uref{http://www.openmp.org/, OpenMP specification v4.1}, Section 4.14
+@end table
+
+
+
 @node OMP_NESTED
 @section @env{OMP_NESTED} -- Nested parallel regions
 @cindex Environment Variable


More information about the Gcc-patches mailing list