openmpi/ompi/runtime/help-mpi-runtime.txt

# -*- text -*-
#
# Copyright (c) 2004-2005 The Trustees of Indiana University.
#                         All rights reserved.
# Copyright (c) 2004-2005 The Trustees of the University of Tennessee.
#                         All rights reserved.
# Copyright (c) 2004-2005 High Performance Computing Center Stuttgart, 
#                         University of Stuttgart.  All rights reserved.
# Copyright (c) 2004-2005 The Regents of the University of California.
#                         All rights reserved.
# $COPYRIGHT$
# 
# Additional copyrights may follow
# 
# $HEADER$
#
# This is the US/English general help file for Open MPI.
#
[mpi_init:startup:internal-failure]
It looks like %s failed for some reason; your parallel process is
likely to abort.  There are many reasons that a parallel process can
fail during %s; some of which are due to configuration or environment
problems.  This failure appears to be an internal failure; here's some
additional information (which may only be relevant to an Open MPI
developer):

  %s
  --> Returned value %d instead of OMPI_SUCCESS
[mpi-param-check-enabled-but-compiled-out]
WARNING: The MCA parameter mpi_param_check has been set to true, but
parameter checking has been compiled out of Open MPI.  The
mpi_param_check value has therefore been ignored.
First cut of the Show Help Subsystem (SHS) - see src/util/show_help.h for details (doxygen); main function call is ompi_show_help() - text message files are expected to be located in $pkgdatadir (usually $prefix/share/openmpi). Anyone can install a text file in $pkgdatadir with their message(s) in it and then have them displayed via ompi_show_help(). "pkgdata_DATA" is the keyword to use in Makefile.am's, for example (from src/mca/base/Makefile.am): pkgdata_DATA = help-mca-base.txt - added a few examples in the code base using ompi_show_help(), but not too many -- can convert more "show_help" comments in the code over time; no huge rush. :-) - no i18n-like support yet; waiting for advice and consensus from other developers This commit was SVN r2519. 2004-09-05 16:05:37 +00:00			`# -- text --`
			`#`
First cut at copyrights: IU, UTK, and some OSU. LANL and HLRS still pending. This commit was SVN r3655. 2004-11-22 01:38:40 +00:00			`# Copyright (c) 2004-2005 The Trustees of Indiana University.`
			`# All rights reserved.`
			`# Copyright (c) 2004-2005 The Trustees of the University of Tennessee.`
			`# All rights reserved.`
Add HLRS copyright This commit was SVN r3665. 2004-11-28 20:09:25 +00:00			`# Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,`
			`# University of Stuttgart. All rights reserved.`
Add UC copyright This commit was SVN r5009. 2005-03-24 12:43:37 +00:00			`# Copyright (c) 2004-2005 The Regents of the University of California.`
			`# All rights reserved.`
First cut at copyrights: IU, UTK, and some OSU. LANL and HLRS still pending. This commit was SVN r3655. 2004-11-22 01:38:40 +00:00			`# $COPYRIGHT$`
			`#`
			`# Additional copyrights may follow`
			`#`
First cut of the Show Help Subsystem (SHS) - see src/util/show_help.h for details (doxygen); main function call is ompi_show_help() - text message files are expected to be located in $pkgdatadir (usually $prefix/share/openmpi). Anyone can install a text file in $pkgdatadir with their message(s) in it and then have them displayed via ompi_show_help(). "pkgdata_DATA" is the keyword to use in Makefile.am's, for example (from src/mca/base/Makefile.am): pkgdata_DATA = help-mca-base.txt - added a few examples in the code base using ompi_show_help(), but not too many -- can convert more "show_help" comments in the code over time; no huge rush. :-) - no i18n-like support yet; waiting for advice and consensus from other developers This commit was SVN r2519. 2004-09-05 16:05:37 +00:00			`# $HEADER$`
			`#`
			`# This is the US/English general help file for Open MPI.`
			`#`
			`[mpi_init:startup:internal-failure]`
			`It looks like %s failed for some reason; your parallel process is`
			`likely to abort. There are many reasons that a parallel process can`
			`fail during %s; some of which are due to configuration or environment`
			`problems. This failure appears to be an internal failure; here's some`
			`additional information (which may only be relevant to an Open MPI`
			`developer):`

			`%s`
			`--> Returned value %d instead of OMPI_SUCCESS`
Change and add new features to the MCA parameter system: - new preferred API calls for registering MCA parameters are mca_base_param_reg_{int\|string} and mca_base_param_reg_{int\|string}_name. - See opal/mca/base/mca_base_param.h for docs on new calls. - Can now register and lookup a value at the same time. - Can now mark a parameter "read only" at registration time - Can now mark a parameter "internal" at registration time - Can now associate a help message with the parameter at registration time; displayed in the ompi_info output. The old API calls are still available for backwards compatibility (mca_base_param_register_{int\|string}. They will eventually be removed -- all developers are encouraged to use the new APIs from here on out and replace any old calls with the new API. Some params were also renamed -- the previous convention of using "base_" as a prefix for any param that was not associated with a component is henceforth deprecated. Instead, use one of the following prefixes: mca: for anything in the MCA base itself opal: for anything in OPAL orte: for anything in ORTE mpi: for anything in OMPI This commit was SVN r6698. 2005-08-01 22:38:17 +00:00			`[mpi-param-check-enabled-but-compiled-out]`
			`WARNING: The MCA parameter mpi_param_check has been set to true, but`
			`parameter checking has been compiled out of Open MPI. The`
			`mpi_param_check value has therefore been ignored.`