This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "MPICH primary repository". The branch, master has been updated via b008288d9f43e3a3c480a8a8e4dd7903c3e2bae0 (commit) via 25c1d520666c400196e459a7d03fa7e86720694b (commit) from 7e45cd368b57176ce1575d7b1197338988556207 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- http://git.mpich.org/mpich.git/commitdiff/b008288d9f43e3a3c480a8a8e4dd7903c3... commit b008288d9f43e3a3c480a8a8e4dd7903c3e2bae0 Author: Wesley Bland <[email protected]> Date: Wed Aug 21 13:38:25 2013 -0500 Add documentation for errhandler callback The MPI_Errhandler callback function is defined as the MPI Standard as having a valist which is implementation specific. This adds a specification for those parameters to the user doc and the man page for MPI_Comm_create_errhandler. Signed-off-by: Pavan Balaji <[email protected]> diff --git a/doc/userguide/user.bib b/doc/userguide/user.bib index db2fc53..8af22cf 100644 --- a/doc/userguide/user.bib +++ b/doc/userguide/user.bib @@ -8,6 +8,14 @@ pages = {1--299} } +@techreport{mpi-forum:mpi3, + author = "{Message Passing Interface Forum}", + title = {{MPI}: A {M}essage {P}assing {I}nterface {S}tandard, Version 3.0}, + year = 2012, + pages = {1--852}, + url = {http://mpi-forum.org/docs/mpi-3.0/mpi30-report.pdf} +} + @Book{Snir:1998:MPI2Book, author = "Marc Snir and Steve W. Otto and Steven Huss-Lederman and David W. Walker and Jack Dongarra", diff --git a/doc/userguide/user.tex.vin b/doc/userguide/user.tex.vin index 455d09e..dd1a926 100644 --- a/doc/userguide/user.tex.vin +++ b/doc/userguide/user.tex.vin @@ -544,6 +544,35 @@ information about this can be found here: \url{http://www.osc.edu/~pw/mpiexec} +\section{Specification of Implementation Details} +\label{sec:specification} + +The MPI Standard defines a number of areas where a library is free to +define its own specific behavior as long as such behavior is documented +appropriately. This section provides that documentation for MPICH where +necessary. + +\subsection{MPI Error Handlers for Communicators} +\label{sec:errhandler} + +In Section 8.3.1 (Error Handlers for Communicators) of the MPI-3.0 +Standard~\cite{mpi-forum:mpi3}, +MPI defines an error handler callback function as + +\begin{verbatim} +typedef void MPI_Comm_errhandler_function(MPI_Comm *, int *, ...); +\end{verbatim} + +Where the first argument is the communicator in use, the second argument is +the error code to be returned by the MPI routine that raised the error, and +the remaining arguments to be implementation specific ``{\texttt varargs}''. +MPICH does not provide any arguments as part of this list. So a callback +function being provided to MPICH is sufficient if the header is + +\begin{verbatim} +typedef void MPI_Comm_errhandler_function(MPI_Comm *, int *); +\end{verbatim} + \section{Debugging} \label{sec:debugging} diff --git a/src/mpi/errhan/comm_create_errhandler.c b/src/mpi/errhan/comm_create_errhandler.c index fe41641..7ceb8a9 100644 --- a/src/mpi/errhan/comm_create_errhandler.c +++ b/src/mpi/errhan/comm_create_errhandler.c @@ -64,6 +64,11 @@ Input Parameters: Output Parameters: . errhandler - MPI error handler (handle) +Error Handler: + The error handler function should be of the form + + void MPI_Comm_errhandler_function(MPI_Comm *comm, int *rc); + .N ThreadSafe .N Fortran http://git.mpich.org/mpich.git/commitdiff/25c1d520666c400196e459a7d03fa7e867... commit 25c1d520666c400196e459a7d03fa7e86720694b Author: Wesley Bland <[email protected]> Date: Fri Aug 23 13:32:30 2013 -0500 Add note about MPI_Init accepting NULL. As of MPI-2, MPI_Init will accept NULL as input parameters. This wasn't mentioned in the man page though this is pertinent information. Signed-off-by: Pavan Balaji <[email protected]> diff --git a/src/mpi/init/init.c b/src/mpi/init/init.c index bc19b0c..b68318a 100644 --- a/src/mpi/init/init.c +++ b/src/mpi/init/init.c @@ -54,6 +54,10 @@ Notes: external state of the program, such as opening files, reading standard input or writing to standard output. +Notes for C: + As of MPI-2, 'MPI_Init' will accept NULL as input parameters. Doing so + will impact the values stored in 'MPI_INFO_ENV'. + Notes for Fortran: The Fortran binding for 'MPI_Init' has only the error return .vb ----------------------------------------------------------------------- Summary of changes: doc/userguide/user.bib | 8 ++++++++ doc/userguide/user.tex.vin | 29 +++++++++++++++++++++++++++++ src/mpi/errhan/comm_create_errhandler.c | 5 +++++ src/mpi/init/init.c | 4 ++++ 4 files changed, 46 insertions(+), 0 deletions(-) hooks/post-receive -- MPICH primary repository