From 613d0f801704b8a155ae26fb08c1f50d069ebae9 Mon Sep 17 00:00:00 2001 From: Ralph Castain Date: Tue, 8 Jul 2008 04:02:31 +0000 Subject: [PATCH] Missed file...just some comment changes, but important ones This commit was SVN r18828. --- ompi/proc/proc.h | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/ompi/proc/proc.h b/ompi/proc/proc.h index 38b484e873..f076af392a 100644 --- a/ompi/proc/proc.h +++ b/ompi/proc/proc.h @@ -119,6 +119,19 @@ OMPI_DECLSPEC extern ompi_proc_t* ompi_proc_local_proc; */ OMPI_DECLSPEC int ompi_proc_init(void); +/** + * Set the arch of each proc in the ompi_proc_list + * + * In some environments, MPI procs are required to exchange their + * arch via a modex operation during mpi_init. In other environments, + * the arch is determined by other mechanisms and provided to the + * proc directly. To support both mechanisms, we provide a separate + * function to set the arch of the procs -after- the modex operation + * has completed in mpi_init. + * + * @retval OMPI_SUCCESS Archs successfully set + * @retval OMPI_ERROR Archs could not be initialized + */ OMPI_DECLSPEC int ompi_proc_set_arch(void); /** @@ -142,8 +155,9 @@ OMPI_DECLSPEC int ompi_proc_finalize(void); * MPI_COMM_WORLD. * * @note The reference count of each process in the array is - * incremented and the caller is responsible for releasing each - * process in the array, as well as freeing the array. + * NOT incremented - the caller is responsible for ensuring the + * correctness of the reference count once they are done with + * the array. * * @param[in] size Number of processes in the ompi_proc_t array *