openmpi/opal/mca/base/help-mca-base.txt

# -*- text -*-
#
# Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
#                         University Research and Technology
#                         Corporation.  All rights reserved.
# Copyright (c) 2004-2005 The University of Tennessee and The University
#                         of Tennessee Research Foundation.  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 (c) 2008      Cisco Systems, Inc.  All rights reserved.
# $COPYRIGHT$
# 
# Additional copyrights may follow
# 
# $HEADER$
#
# This is the US/English help file for Open MPI MCA error messages.
#
[find-available:none-found]
No available %s components were found!

This means that there are no components of this type installed on your
system or all the components reported that they could not be used.

This is a fatal error; your MPI process is likely to abort.  Check the
output of the "ompi_info" command and ensure that components of this
type are available on your system.  You may also wish to check the
value of the "component_path" MCA parameter and ensure that it has at
least one directory that contains valid MCA components.
#
[find-available:not-valid]
A requested component was not found, or was unable to be opened.  This
means that this component is either not installed or is unable to be
used on your system (e.g., sometimes this means that shared libraries
that the component requires are unable to be found/loaded).  Note that
Open MPI stopped checking at the first component that it did not find.

Host:      %s
Framework: %s
Component: %s
#
[framework-param:too-many-negates]
MCA framework parameters can only take a single negation operator
("^"), and it must be at the beginning of the value.  The following
value violates this rule:

    %s

When used, the negation operator sets the "exclusive" behavior mode,
meaning that it will exclude all specified components (and implicitly
include all others).  If the negation operator is not specified, the
"inclusive" mode is assumed, meaning that all specified components
will be included (and implicitly exclude all others).

For example, "^a,b" specifies the exclusive behavior and means "use
all components *except* a and b", while "c,d" specifies the inclusive
behavior and means "use *only* components c and d."

You cannot mix inclusive and exclusive behavior.
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 20:05:37 +04:00			`# -- text --`
			`#`
Update the copyright notices for IU and UTK. This commit was SVN r7999. 2005-11-05 22:57:48 +03:00			`# Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana`
			`# University Research and Technology`
			`# Corporation. All rights reserved.`
			`# Copyright (c) 2004-2005 The University of Tennessee and The University`
			`# of Tennessee Research Foundation. All rights`
			`# reserved.`
Add HLRS copyright This commit was SVN r3665. 2004-11-28 23:09:25 +03: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 15:43:37 +03:00			`# Copyright (c) 2004-2005 The Regents of the University of California.`
			`# All rights reserved.`
Fixes trac:1338: Have the MCA base specifically check for all requested components. If they are not found / able to be opened, a warning will be printed and the mca_base_component_find() will return OPAL_ERR_NOT_FOUND. It is the upper-layer's responsibility to handle this error appropriately. This commit was SVN r18707. The following Trac tickets were found above: Ticket 1338 --> https://svn.open-mpi.org/trac/ompi/ticket/1338 2008-06-23 20:14:05 +04:00			`# Copyright (c) 2008 Cisco Systems, Inc. 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 04:38:40 +03: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 20:05:37 +04:00			`# $HEADER$`
			`#`
			`# This is the US/English help file for Open MPI MCA error messages.`
			`#`
			`[find-available:none-found]`
			`No available %s components were found!`

			`This means that there are no components of this type installed on your`
			`system or all the components reported that they could not be used.`

			`This is a fatal error; your MPI process is likely to abort. Check the`
			`output of the "ompi_info" command and ensure that components of this`
			`type are available on your system. You may also wish to check the`
			`value of the "component_path" MCA parameter and ensure that it has at`
			`least one directory that contains valid MCA components.`
Fixes trac:1338: Have the MCA base specifically check for all requested components. If they are not found / able to be opened, a warning will be printed and the mca_base_component_find() will return OPAL_ERR_NOT_FOUND. It is the upper-layer's responsibility to handle this error appropriately. This commit was SVN r18707. The following Trac tickets were found above: Ticket 1338 --> https://svn.open-mpi.org/trac/ompi/ticket/1338 2008-06-23 20:14:05 +04:00			`#`
Added some userlevel error checking, and messaging. This commit was SVN r6440. 2005-07-12 22:06:31 +04:00			`[find-available:not-valid]`
Fixes trac:1338: Have the MCA base specifically check for all requested components. If they are not found / able to be opened, a warning will be printed and the mca_base_component_find() will return OPAL_ERR_NOT_FOUND. It is the upper-layer's responsibility to handle this error appropriately. This commit was SVN r18707. The following Trac tickets were found above: Ticket 1338 --> https://svn.open-mpi.org/trac/ompi/ticket/1338 2008-06-23 20:14:05 +04:00			`A requested component was not found, or was unable to be opened. This`
			`means that this component is either not installed or is unable to be`
			`used on your system (e.g., sometimes this means that shared libraries`
			`that the component requires are unable to be found/loaded). Note that`
			`Open MPI stopped checking at the first component that it did not find.`

			`Host: %s`
			`Framework: %s`
			`Component: %s`
			`#`
Be a little smarter when checking the MCA parameters that specify what components to load: - only allow the ^ to be the first character of the value - if we find ^ elsewhere in the value, print an error and fail This commit was SVN r10880. 2006-07-19 18:19:44 +04:00			`[framework-param:too-many-negates]`
			`MCA framework parameters can only take a single negation operator`
			`("^"), and it must be at the beginning of the value. The following`
			`value violates this rule:`

			`%s`

			`When used, the negation operator sets the "exclusive" behavior mode,`
			`meaning that it will exclude all specified components (and implicitly`
			`include all others). If the negation operator is not specified, the`
			`"inclusive" mode is assumed, meaning that all specified components`
			`will be included (and implicitly exclude all others).`

			`For example, "^a,b" specifies the exclusive behavior and means "use`
			`all components except a and b", while "c,d" specifies the inclusive`
			`behavior and means "use only components c and d."`

			`You cannot mix inclusive and exclusive behavior.`