[openmp, committed]: fix typos and prototypes
Aldy Hernandez
aldyh@redhat.com
Mon Jul 26 16:21:00 GMT 2010
Hi.
The following patch fixes some spelling and pasto problems throughout.
It also fixes some prototypes to match the actual code.
Jakub approved the patch off-list.
Committing to trunk.
* libgomp.texi: Fix spelling and pasto problems throughout.
Adjust prototypes to match code.
Index: libgomp.texi
===================================================================
--- libgomp.texi (revision 162535)
+++ libgomp.texi (working copy)
@@ -137,14 +137,14 @@ Control threads, processors and the para
* omp_get_ancestor_thread_num:: Ancestor thread ID
* omp_get_dynamic:: Dynamic teams setting
* omp_get_level:: Number of parallel regions
-* omp_get_max_active_levels:: Maximal number of active regions
-* omp_get_max_threads:: Maximal number of threads of parallel region
+* omp_get_max_active_levels:: Maximum number of active regions
+* omp_get_max_threads:: Maximum number of threads of parallel region
* omp_get_nested:: Nested parallel regions
* omp_get_num_procs:: Number of processors online
* omp_get_num_threads:: Size of the active team
* omp_get_schedule:: Obtain the runtime scheduling method
* omp_get_team_size:: Number of threads in a team
-* omp_get_thread_limit:: Maximal number of threads
+* omp_get_thread_limit:: Maximum number of threads
* omp_get_thread_num:: Current thread ID
* omp_in_parallel:: Whether a parallel region is active
* omp_set_dynamic:: Enable/disable dynamic teams
@@ -187,7 +187,7 @@ which enclose the calling call.
@item @emph{C/C++}
@multitable @columnfractions .20 .80
-@item @emph{Prototype}: @tab @code{int omp_get_active_level();}
+@item @emph{Prototype}: @tab @code{int omp_get_active_level(void);}
@end multitable
@item @emph{Fortran}:
@@ -220,7 +220,7 @@ zero to @code{omp_get_level} -1 is retur
@item @emph{Fortran}:
@multitable @columnfractions .20 .80
-@item @emph{Interface}: @tab @code{integer omp_ancestor_thread_num(level)}
+@item @emph{Interface}: @tab @code{integer omp_get_ancestor_thread_num(level)}
@item @tab @code{integer level}
@end multitable
@@ -248,7 +248,7 @@ disabled by default.
@item @emph{C/C++}:
@multitable @columnfractions .20 .80
-@item @emph{Prototype}: @tab @code{int omp_get_dynamic();}
+@item @emph{Prototype}: @tab @code{int omp_get_dynamic(void);}
@end multitable
@item @emph{Fortran}:
@@ -274,7 +274,7 @@ which enclose the calling call.
@item @emph{C/C++}
@multitable @columnfractions .20 .80
-@item @emph{Prototype}: @tab @code{int omp_get level();}
+@item @emph{Prototype}: @tab @code{int omp_get_level(void);}
@end multitable
@item @emph{Fortran}:
@@ -292,14 +292,14 @@ which enclose the calling call.
@node omp_get_max_active_levels
-@section @code{omp_set_max_active_levels} -- Maximal number of active regions
+@section @code{omp_get_max_active_levels} -- Maximum number of active regions
@table @asis
@item @emph{Description}:
-This function obtains the maximally allowed number of nested, active parallel regions.
+This function obtains the maximum allowed number of nested, active parallel regions.
@item @emph{C/C++}
@multitable @columnfractions .20 .80
-@item @emph{Prototype}: @tab @code{int omp_get_max_active_levels();}
+@item @emph{Prototype}: @tab @code{int omp_get_max_active_levels(void);}
@end multitable
@item @emph{Fortran}:
@@ -317,15 +317,15 @@ This function obtains the maximally allo
@node omp_get_max_threads
-@section @code{omp_get_max_threads} -- Maximal number of threads of parallel region
+@section @code{omp_get_max_threads} -- Maximum number of threads of parallel region
@table @asis
@item @emph{Description}:
-Return the maximal number of threads used for the current parallel region
+Return the maximum number of threads used for the current parallel region
that does not use the clause @code{num_threads}.
@item @emph{C/C++}:
@multitable @columnfractions .20 .80
-@item @emph{Prototype}: @tab @code{int omp_get_max_threads();}
+@item @emph{Prototype}: @tab @code{int omp_get_max_threads(void);}
@end multitable
@item @emph{Fortran}:
@@ -357,7 +357,7 @@ disabled by default.
@item @emph{C/C++}:
@multitable @columnfractions .20 .80
-@item @emph{Prototype}: @tab @code{int omp_get_nested();}
+@item @emph{Prototype}: @tab @code{int omp_get_nested(void);}
@end multitable
@item @emph{Fortran}:
@@ -382,7 +382,7 @@ Returns the number of processors online.
@item @emph{C/C++}:
@multitable @columnfractions .20 .80
-@item @emph{Prototype}: @tab @code{int omp_get_num_procs();}
+@item @emph{Prototype}: @tab @code{int omp_get_num_procs(void);}
@end multitable
@item @emph{Fortran}:
@@ -400,7 +400,7 @@ Returns the number of processors online.
@section @code{omp_get_num_threads} -- Size of the active team
@table @asis
@item @emph{Description}:
-The number of threads in the current team. In a sequential section of
+Returns the number of threads in the current team. In a sequential section of
the program @code{omp_get_num_threads} returns 1.
The default team size may be initialized at startup by the
@@ -412,7 +412,7 @@ one thread per CPU online is used.
@item @emph{C/C++}:
@multitable @columnfractions .20 .80
-@item @emph{Prototype}: @tab @code{int omp_get_num_threads();}
+@item @emph{Prototype}: @tab @code{int omp_get_num_threads(void);}
@end multitable
@item @emph{Fortran}:
@@ -433,14 +433,14 @@ one thread per CPU online is used.
@section @code{omp_get_schedule} -- Obtain the runtime scheduling method
@table @asis
@item @emph{Description}:
-Obtain runtime the scheduling method. The @var{kind} argument will be
+Obtain the runtime scheduling method. The @var{kind} argument will be
set to the value @code{omp_sched_static}, @code{omp_sched_dynamic},
-@code{opm_sched_guided} or @code{auto}. The second argument, @var{modifier},
-is set to the chunk size.
+@code{omp_sched_guided} or @code{omp_sched_auto}. The second argument,
+@var{modifier}, is set to the chunk size.
@item @emph{C/C++}
@multitable @columnfractions .20 .80
-@item @emph{Prototype}: @tab @code{omp_schedule(omp_sched_t * kind, int *modifier);}
+@item @emph{Prototype}: @tab @code{omp_schedule(omp_sched_t *kind, int *modifier);}
@end multitable
@item @emph{Fortran}:
@@ -465,13 +465,13 @@ is set to the chunk size.
@item @emph{Description}:
This function returns the number of threads in a thread team to which
either the current thread or its ancestor belongs. For values of @var{level}
-outside zero to @code{omp_get_level} -1 is returned; if @var{level} is zero
-1 is returned and for @code{omp_get_level} the result is identical
+outside zero to @code{omp_get_level}, -1 is returned; if @var{level} is zero,
+1 is returned, and for @code{omp_get_level}, the result is identical
to @code{omp_get_num_threads}.
@item @emph{C/C++}:
@multitable @columnfractions .20 .80
-@item @emph{Prototype}: @tab @code{int omp_get_time_size(int level);}
+@item @emph{Prototype}: @tab @code{int omp_get_team_size(int level);}
@end multitable
@item @emph{Fortran}:
@@ -490,14 +490,14 @@ to @code{omp_get_num_threads}.
@node omp_get_thread_limit
-@section @code{omp_get_thread_limit} -- Maximal number of threads
+@section @code{omp_get_thread_limit} -- Maximum number of threads
@table @asis
@item @emph{Description}:
-Return the maximal number of threads of the program.
+Return the maximum number of threads of the program.
@item @emph{C/C++}:
@multitable @columnfractions .20 .80
-@item @emph{Prototype}: @tab @code{int omp_get_thread_limit();}
+@item @emph{Prototype}: @tab @code{int omp_get_thread_limit(void);}
@end multitable
@item @emph{Fortran}:
@@ -518,7 +518,7 @@ Return the maximal number of threads of
@section @code{omp_get_thread_num} -- Current thread ID
@table @asis
@item @emph{Description}:
-Unique thread identification number within the current team.
+Returns a unique thread identification number within the current team.
In a sequential parts of the program, @code{omp_get_thread_num}
always returns 0. In parallel regions the return value varies
from 0 to @code{omp_get_num_threads}-1 inclusive. The return
@@ -526,7 +526,7 @@ value of the master thread of a team is
@item @emph{C/C++}:
@multitable @columnfractions .20 .80
-@item @emph{Prototype}: @tab @code{int omp_get_thread_num();}
+@item @emph{Prototype}: @tab @code{int omp_get_thread_num(void);}
@end multitable
@item @emph{Fortran}:
@@ -553,7 +553,7 @@ their language-specific counterparts.
@item @emph{C/C++}:
@multitable @columnfractions .20 .80
-@item @emph{Prototype}: @tab @code{int omp_in_parallel();}
+@item @emph{Prototype}: @tab @code{int omp_in_parallel(void);}
@end multitable
@item @emph{Fortran}:
@@ -577,7 +577,7 @@ adjustment of team sizes and @code{false
@item @emph{C/C++}:
@multitable @columnfractions .20 .80
-@item @emph{Prototype}: @tab @code{void omp_set_dynamic(int);}
+@item @emph{Prototype}: @tab @code{void omp_set_dynamic(int set);}
@end multitable
@item @emph{Fortran}:
@@ -599,16 +599,17 @@ adjustment of team sizes and @code{false
@section @code{omp_set_max_active_levels} -- Limits the number of active parallel regions
@table @asis
@item @emph{Description}:
-This function limits the maximally allowed number of nested, active parallel regions.
+This function limits the maximum allowed number of nested, active
+parallel regions.
@item @emph{C/C++}
@multitable @columnfractions .20 .80
-@item @emph{Prototype}: @tab @code{omp_set_max_active_levels(int max_levels);}
+@item @emph{Prototype}: @tab @code{void omp_set_max_active_levels(int max_levels);}
@end multitable
@item @emph{Fortran}:
@multitable @columnfractions .20 .80
-@item @emph{Interface}: @tab @code{omp_max_active_levels(max_levels)}
+@item @emph{Interface}: @tab @code{subroutine omp_set_max_active_levels(max_levels)}
@item @tab @code{integer max_levels}
@end multitable
@@ -632,12 +633,12 @@ dynamic adjustment of team sizes and @co
@item @emph{C/C++}:
@multitable @columnfractions .20 .80
-@item @emph{Prototype}: @tab @code{void omp_set_dynamic(int);}
+@item @emph{Prototype}: @tab @code{void omp_set_nested(int set);}
@end multitable
@item @emph{Fortran}:
@multitable @columnfractions .20 .80
-@item @emph{Interface}: @tab @code{subroutine omp_set_dynamic(set)}
+@item @emph{Interface}: @tab @code{subroutine omp_set_nested(set)}
@item @tab @code{integer, intent(in) :: set}
@end multitable
@@ -660,13 +661,13 @@ argument of @code{omp_set_num_threads} s
@item @emph{C/C++}:
@multitable @columnfractions .20 .80
-@item @emph{Prototype}: @tab @code{void omp_set_num_threads(int);}
+@item @emph{Prototype}: @tab @code{void omp_set_num_threads(int n);}
@end multitable
@item @emph{Fortran}:
@multitable @columnfractions .20 .80
-@item @emph{Interface}: @tab @code{subroutine omp_set_num_threads(set)}
-@item @tab @code{integer, intent(in) :: set}
+@item @emph{Interface}: @tab @code{subroutine omp_set_num_threads(n)}
+@item @tab @code{integer, intent(in) :: n}
@end multitable
@item @emph{See also}:
@@ -684,19 +685,19 @@ argument of @code{omp_set_num_threads} s
@item @emph{Description}:
Sets the runtime scheduling method. The @var{kind} argument can have the
value @code{omp_sched_static}, @code{omp_sched_dynamic},
-@code{opm_sched_guided} or @code{omp_sched_auto}. Except for
+@code{omp_sched_guided} or @code{omp_sched_auto}. Except for
@code{omp_sched_auto}, the chunk size is set to the value of
-@var{modifier} if positive or to the default value if zero or negative.
+@var{modifier} if positive, or to the default value if zero or negative.
For @code{omp_sched_auto} the @var{modifier} argument is ignored.
@item @emph{C/C++}
@multitable @columnfractions .20 .80
-@item @emph{Prototype}: @tab @code{int omp_schedule(omp_sched_t * kind, int *modifier);}
+@item @emph{Prototype}: @tab @code{int omp_set_schedule(omp_sched_t *kind, int *modifier);}
@end multitable
@item @emph{Fortran}:
@multitable @columnfractions .20 .80
-@item @emph{Interface}: @tab @code{subroutine omp_schedule(kind, modifier)}
+@item @emph{Interface}: @tab @code{subroutine omp_set_schedule(kind, modifier)}
@item @tab @code{integer(kind=omp_sched_kind) kind}
@item @tab @code{integer modifier}
@end multitable
@@ -715,7 +716,7 @@ For @code{omp_sched_auto} the @var{modif
@section @code{omp_init_lock} -- Initialize simple lock
@table @asis
@item @emph{Description}:
-Initialize a simple lock. After initialization, the lock is in
+Initialize a simple lock. After initialization, the lock is in
an unlocked state.
@item @emph{C/C++}:
@@ -805,7 +806,7 @@ does not block if the lock is not availa
A simple lock about to be unset must have been locked by @code{omp_set_lock}
or @code{omp_test_lock} before. In addition, the lock must be held by the
thread calling @code{omp_unset_lock}. Then, the lock becomes unlocked. If one
-ore more threads attempted to set the lock before, one of them is chosen to,
+or more threads attempted to set the lock before, one of them is chosen to,
again, set the lock for itself.
@item @emph{C/C++}:
@@ -837,7 +838,7 @@ in the unlocked state.
@item @emph{C/C++}:
@multitable @columnfractions .20 .80
-@item @emph{Prototype}: @tab @code{void omp_destroy_lock(omp_lock_t *);}
+@item @emph{Prototype}: @tab @code{void omp_destroy_lock(omp_lock_t *lock);}
@end multitable
@item @emph{Fortran}:
@@ -859,7 +860,7 @@ in the unlocked state.
@section @code{omp_init_nest_lock} -- Initialize nested lock
@table @asis
@item @emph{Description}:
-Initialize a nested lock. After initialization, the lock is in
+Initialize a nested lock. After initialization, the lock is in
an unlocked state and the nesting count is set to zero.
@item @emph{C/C++}:
@@ -882,7 +883,7 @@ an unlocked state and the nesting count
@node omp_set_nest_lock
-@section @code{omp_set_nest_lock} -- Wait for and set simple lock
+@section @code{omp_set_nest_lock} -- Wait for and set nested lock
@table @asis
@item @emph{Description}:
Before setting a nested lock, the lock variable must be initialized by
@@ -1008,7 +1009,7 @@ successive clock ticks.
@item @emph{C/C++}:
@multitable @columnfractions .20 .80
-@item @emph{Prototype}: @tab @code{double omp_get_wtick();}
+@item @emph{Prototype}: @tab @code{double omp_get_wtick(void);}
@end multitable
@item @emph{Fortran}:
@@ -1030,13 +1031,13 @@ successive clock ticks.
@table @asis
@item @emph{Description}:
Elapsed wall clock time in seconds. The time is measured per thread, no
-guarantee can bee made that two distinct threads measure the same time.
+guarantee can be made that two distinct threads measure the same time.
Time is measured from some "time in the past". On POSIX compliant systems
the seconds since the Epoch (00:00:00 UTC, January 1, 1970) are returned.
@item @emph{C/C++}:
@multitable @columnfractions .20 .80
-@item @emph{Prototype}: @tab @code{double omp_get_wtime();}
+@item @emph{Prototype}: @tab @code{double omp_get_wtime(void);}
@end multitable
@item @emph{Fortran}:
@@ -1069,12 +1070,12 @@ extensions.
@menu
* OMP_DYNAMIC:: Dynamic adjustment of threads
-* OMP_MAX_ACTIVE_LEVELS:: Set the maximal number of nested parallel regions
+* OMP_MAX_ACTIVE_LEVELS:: Set the maximum number of nested parallel regions
* OMP_NESTED:: Nested parallel regions
* OMP_NUM_THREADS:: Specifies the number of threads to use
* OMP_STACKSIZE:: Set default thread stack size
* OMP_SCHEDULE:: How threads are scheduled
-* OMP_THREAD_LIMIT:: Set the maximal number of threads
+* OMP_THREAD_LIMIT:: Set the maximum number of threads
* OMP_WAIT_POLICY:: How waiting threads are handled
* GOMP_CPU_AFFINITY:: Bind threads to specific CPUs
* GOMP_STACKSIZE:: Set default thread stack size
@@ -1101,11 +1102,11 @@ disabled by default.
@node OMP_MAX_ACTIVE_LEVELS
-@section @env{OMP_MAX_ACTIVE_LEVELS} -- Set the maximal number of nested parallel regions
+@section @env{OMP_MAX_ACTIVE_LEVELS} -- Set the maximum number of nested parallel regions
@cindex Environment Variable
@table @asis
@item @emph{Description}:
-Specifies the initial value for the maximal number of nested parallel
+Specifies the initial value for the maximum number of nested parallel
regions. The value of this variable shall be positive integer.
If undefined, the number of active levels is unlimited.
@@ -1145,8 +1146,8 @@ regions are disabled by default.
@table @asis
@item @emph{Description}:
Specifies the default number of threads to use in parallel regions. The
-value of this variable shall be positive integer. If undefined one thread
-per CPU online is used.
+value of this variable shall be a positive integer. If undefined one thread
+per CPU is used.
@item @emph{See also}:
@ref{omp_set_num_threads}
@@ -1187,7 +1188,7 @@ Set the default thread stack size in kil
is suffixed by @code{B}, @code{K}, @code{M} or @code{G}, in which
case the size is, respectively, in bytes, kilobytes, megabytes
or gigabytes. This is different from @code{pthread_attr_setstacksize}
-which gets the number of bytes as an argument. If the stacksize can not
+which gets the number of bytes as an argument. If the stacksize cannot
be set due to system constraints, an error is reported and the initial
stacksize is left unchanged. If undefined, the stack size is system
dependent.
@@ -1199,12 +1200,12 @@ dependent.
@node OMP_THREAD_LIMIT
-@section @env{OMP_THREAD_LIMIT} -- Set the maximal number of threads
+@section @env{OMP_THREAD_LIMIT} -- Set the maximum number of threads
@cindex Environment Variable
@table @asis
@item @emph{Description}:
Specifies the number of threads to use for the whole program. The
-value of this variable shall be positive integer. If undefined,
+value of this variable shall be a positive integer. If undefined,
the number of threads is not limited.
@item @emph{See also}:
@@ -1238,15 +1239,15 @@ they should.
@cindex Environment Variable
@table @asis
@item @emph{Description}:
-Binds threads to specific CPUs. The variable should contain a space- or
-comma-separated list of CPUs. This list may contain different kind of
+Binds threads to specific CPUs. The variable should contain a space-separated
+or comma-separated list of CPUs. This list may contain different kinds of
entries: either single CPU numbers in any order, a range of CPUs (M-N)
-or a range with some stride (M-N:S). CPU numbers are zero based. For example,
+or a range with some stride (M-N:S). CPU numbers are zero based. For example,
@code{GOMP_CPU_AFFINITY="0 3 1-2 4-15:2"} will bind the initial thread
to CPU 0, the second to CPU 3, the third to CPU 1, the fourth to
CPU 2, the fifth to CPU 4, the sixth through tenth to CPUs 6, 8, 10, 12,
and 14 respectively and then start assigning back from the beginning of
-the list. @code{GOMP_CPU_AFFINITY=0} binds all threads to CPU 0.
+the list. @code{GOMP_CPU_AFFINITY=0} binds all threads to CPU 0.
There is no GNU OpenMP library routine to determine whether a CPU affinity
specification is in effect. As a workaround, language-specific library
@@ -1269,7 +1270,7 @@ assignment of threads to CPUs.
@item @emph{Description}:
Set the default thread stack size in kilobytes. This is different from
@code{pthread_attr_setstacksize} which gets the number of bytes as an
-argument. If the stacksize can not be set due to system constraints, an
+argument. If the stacksize cannot be set due to system constraints, an
error is reported and the initial stacksize is left unchanged. If undefined,
the stack size is system dependent.
@@ -1293,7 +1294,7 @@ GCC Patches Mailinglist}
@chapter The libgomp ABI
The following sections present notes on the external ABI as
-presented by libgomp. Only maintainers should need them.
+presented by libgomp. Only maintainers should need them.
@menu
* Implementing MASTER construct::
@@ -1323,7 +1324,7 @@ if (omp_get_thread_num () == 0)
Alternately, we generate two copies of the parallel subfunction
and only include this in the version run by the master thread.
-Surely that's not worthwhile though...
+Surely this is not worthwhile though...
@@ -1348,7 +1349,7 @@ name being transformed into a variable d
@end smallexample
Ideally the ABI would specify that all zero is a valid unlocked
-state, and so we wouldn't actually need to initialize this at
+state, and so we wouldn't need to initialize this at
startup.
@@ -1415,14 +1416,14 @@ the semantic of new variable creation.
@node Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses
@section Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses
-Seems simple enough for PARALLEL blocks. Create a private
-struct for communicating between parent and subfunction.
+This seems simple enough for PARALLEL blocks. Create a private
+struct for communicating between the parent and subfunction.
In the parent, copy in values for scalar and "small" structs;
copy in addresses for others TREE_ADDRESSABLE types. In the
subfunction, copy the value into the local variable.
-Not clear at all what to do with bare FOR or SECTION blocks.
-The only thing I can figure is that we do something like
+It is not clear what to do with bare FOR or SECTION blocks.
+The only thing I can figure is that we do something like:
@smallexample
#pragma omp for firstprivate(x) lastprivate(y)
@@ -1459,7 +1460,7 @@ broadcast would have to happen via SINGL
The private struct mentioned in the previous section should have
a pointer to an array of the type of the variable, indexed by the
thread's @var{team_id}. The thread stores its final value into the
-array, and after the barrier the master thread iterates over the
+array, and after the barrier, the master thread iterates over the
array to collect the values.
@@ -1564,7 +1565,7 @@ becomes
@}
@end smallexample
-Note that while it looks like there is trickyness to propagating
+Note that while it looks like there is trickiness to propagating
a non-constant STEP, there isn't really. We're explicitly allowed
to evaluate it as many times as we want, and any variables involved
should automatically be handled as PRIVATE or SHARED like any other
@@ -1682,7 +1683,7 @@ becomes
@chapter Reporting Bugs
Bugs in the GNU OpenMP implementation should be reported via
-@uref{http://gcc.gnu.org/bugzilla/, bugzilla}. In all cases, please add
+@uref{http://gcc.gnu.org/bugzilla/, bugzilla}. For all cases, please add
"openmp" to the keywords field in the bug report.
More information about the Gcc-patches
mailing list