public inbox for gcc-patches@gcc.gnu.org
 help / color / mirror / Atom feed
From: Daniel Franke <franke.daniel@gmail.com>
To: gcc-patches@gcc.gnu.org
Cc: Tobias Burnus <burnus@net-b.de>
Subject: [libgomp, doc, patch] document implementation specific default values
Date: Sun, 07 Jan 2007 18:24:00 -0000	[thread overview]
Message-ID: <200701071924.07558.franke.daniel@gmail.com> (raw)

[-- Attachment #1: Type: text/plain, Size: 432 bytes --]


:ADDPATCH libgomp:


2007-01-07  Daniel Franke <franke.daniel@gmail.com>

	* libgomp.texi: Document implementation specific default values of 
environment variables.


As requested by Tobias in private mail, this patch adds the default values of 
OMP related environment variables to the corresponding sections of the 
documentation.

Ok for trunk?

	Daniel


P.S. After these changes got applied, I will backport the docs to 4.2.

[-- Attachment #2: libgomp.texi.diff --]
[-- Type: text/x-diff, Size: 2507 bytes --]

Index: libgomp.texi
===================================================================
--- libgomp.texi	(revision 120546)
+++ libgomp.texi	(working copy)
@@ -412,10 +412,6 @@
 sections, if those do not specify a @code{num_threads} clause. The 
 argument of @code{omp_set_num_threads} shall be a positive integer. 
 
-If the argument is negative integer or zero, the application will crash or
-stop, respectively. An enhancement request was filed,
-@uref{http://gcc.gnu.org/bugzilla/show_bug.cgi?id=29949, PR29949}.
-
 @item @emph{C/C++}:
 @multitable @columnfractions .20 .80
 @item @emph{Prototype}: @tab @code{void omp_set_num_threads(int);}
@@ -807,7 +803,8 @@
 @item @emph{Description}:
 Enable or disable the dynamic adjustment of the number of threads 
 within a team. The value of this environment variable shall be 
-@code{TRUE} or @code{FALSE}.
+@code{TRUE} or @code{FALSE}. If undefined, dynamic adjustment is
+disabled by default.
 
 @item @emph{See also}:
 @ref{omp_set_dynamic}
@@ -825,7 +822,8 @@
 @item @emph{Description}:
 Enable or disable nested parallel regions, i. e. whether team members
 are allowed to create new teams. The value of this environment variable 
-shall be @code{TRUE} or @code{FALSE}.
+shall be @code{TRUE} or @code{FALSE}. If undefined, nested parallel 
+regions are disabled by default.
 
 @item @emph{See also}:
 @ref{omp_set_nested}
@@ -862,10 +860,11 @@
 Allows to specify @code{schedule type} and @code{chunk size}. 
 The value of the variable shall have the form: @code{type[,chunk]} where
 @code{type} is one of @code{static}, @code{dynamic} or @code{guided}. 
-The optional @code{chunk size} shall be a positive integer. 
+The optional @code{chunk size} shall be a positive integer. If undefined,
+dynamic scheduling and a chunk size of 1 is used.
 
 @item @emph{Reference}: 
-@uref{http://www.openmp.org/, OpenMP specifications v2.5}, section 4.1
+@uref{http://www.openmp.org/, OpenMP specifications v2.5}, sections 2.5.1 and 4.1
 @end table
 
 
@@ -895,7 +894,8 @@
 Set the default thread stack size in kilobytes. This is in opposition 
 to @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 
-error is reported and the initial stacksize is left unchanged.
+error is reported and the initial stacksize is left unchanged. If undefined,
+the stack size is system dependent.
 
 @item @emph{Reference}: 
 @uref{http://gcc.gnu.org/ml/gcc-patches/2006-06/msg00493.html, 

             reply	other threads:[~2007-01-07 18:24 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-01-07 18:24 Daniel Franke [this message]
2007-01-14 20:17 ` Daniel Franke

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=200701071924.07558.franke.daniel@gmail.com \
    --to=franke.daniel@gmail.com \
    --cc=burnus@net-b.de \
    --cc=gcc-patches@gcc.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).