openmpi/opal/mca/base/help-mca-var.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-2011 Cisco Systems, Inc.  All rights reserved.
# Copyright (c) 2013      Los Alamos National Security, LLC. All rights
#                         reserved.
# $COPYRIGHT$
# 
# Additional copyrights may follow
# 
# $HEADER$
#
# This is the US/English help file for Open MPI MCA error messages.
#
[invalid-flag-combination]
ERROR: An invalid combination of flags was passed to mca_base_var_register.

  Variable: %s
  Flags:    %s %s
#
[default-only-param-set]
WARNING: A user-supplied value attempted to override the default-only MCA
variable named "%s".

The user-supplied value was ignored.
#
[missing-param-file]
Process %d Unable to locate the variable file "%s" in the following search path:
   %s
#
[deprecated-mca-env]
A deprecated MCA variable value was specified in the environment or
on the command line.  Deprecated MCA variables should be avoided;
they may disappear in future releases.

  Deprecated variable: %s
#
[deprecated-mca-cli]
A deprecated MCA variable value was specified on the command line.  Deprecated
MCA variables should be avoided; they may disappear in future releases.

  Deprecated variable: %s
#
[deprecated-mca-file]
A deprecated MCA variable value was specified in an MCA variable
file.  Deprecated MCA variables should be avoided; they may disappear
in future releases.

  Deprecated variable: %s
  Source file:         %s
#
[mutually-exclusive-vars]
Two mutually-exclusive MCA variables were specified.  This can result
in undefined behavior, such as ignoring the components that the MCA
variables are supposed to affect.

  1st MCA variable: %s
    Source of value: %s
  2nd MCA variable: %s
    Source of value: %s
#
[re-register-with-different-type]
An MCA variable was re-registered with a different type (i.e., it was
either originally registered as an INT and re-registered as a STRING,
or it was originially registered as a STRING and re-registered as an
INT).  This a developer error; your job may abort.

  MCA variable name: %s
#
[var-name-conflict]
A name collision was detected on an MCA variable name. This can happen
if two components try to register the same variable with slightly
different name components. The conflicting variables are listed below:

  MCA variable name: %s
  New name: %s %s %s
  Existing name: %s %s %s
#
[overridden-param-set]
WARNING: A user-supplied value attempted to set a variable that is set
in the override variable file (openmpi-mca-params-override.conf).

  Variable: %s

The user-supplied value was ignored.
#
[invalid-value]
An invalid value was supplied for an enum variable.

  Variable     : %s
  Value        : %s
#
[invalid-value-enum]
An invalid value was supplied for an enum variable.

  Variable     : %s
  Value        : %s
  Valid values : %s
#
[environment-only-param]
WARNING: The special MCA parameter "%s" was set in
an unexpected way, and is likely not working the way you want it to.

Specifically, this MCA parameter is "special" in that it can *only* be
set in the environment.  Setting this value in a file -- and sometimes
even on the command line -- will not work as intended.  The *only* way
to set this value is to set "OMPI_MCA_%s" in the environment before
starting your job.

  Value:      %s
  Source:     %s
MCA/base: Add new MCA variable system Features: - Support for an override parameter file (openmpi-mca-param-override.conf). Variable values in this file can not be overridden by any file or environment value. - Support for boolean, unsigned, and unsigned long long variables. - Support for true/false values. - Support for enumerations on integer variables. - Support for MPIT scope, verbosity, and binding. - Support for command line source. - Support for setting variable source via the environment using OMPI_MCA_SOURCE_<var name>=source (either command or file:filename) - Cleaner API. - Support for variable groups (equivalent to MPIT categories). Notes: - Variables must be created with a backing store (char *, int , or bool *) that must live at least as long as the variable. - Creating a variable with the MCA_BASE_VAR_FLAG_SETTABLE enables the use of mca_base_var_set_value() to change the value. - String values are duplicated when the variable is registered. It is up to the caller to free the original value if necessary. The new value will be freed by the mca_base_var system and must not be freed by the user. - Variables with constant scope may not be settable. - Variable groups (and all associated variables) are deregistered when the component is closed or the component repository item is freed. This prevents a segmentation fault from accessing a variable after its component is unloaded. - After some discussion we decided we should remove the automatic registration of component priority variables. Few component actually made use of this feature. - The enumerator interface was updated to be general enough to handle future uses of the interface. - The code to generate ompi_info output has been moved into the MCA variable system. See mca_base_var_dump(). opal: update core and components to mca_base_var system orte: update core and components to mca_base_var system ompi: update core and components to mca_base_var system This commit also modifies the rmaps framework. The following variables were moved from ppr and lama: rmaps_base_pernode, rmaps_base_n_pernode, rmaps_base_n_persocket. Both lama and ppr create synonyms for these variables. This commit was SVN r28236. 2013-03-28 01:09:41 +04:00			`# -- 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-2011 Cisco Systems, Inc. All rights reserved.`
			`# Copyright (c) 2013 Los Alamos National Security, LLC. All rights`
			`# reserved.`
			`# $COPYRIGHT$`
			`#`
			`# Additional copyrights may follow`
			`#`
			`# $HEADER$`
			`#`
			`# This is the US/English help file for Open MPI MCA error messages.`
			`#`
			`[invalid-flag-combination]`
			`ERROR: An invalid combination of flags was passed to mca_base_var_register.`

			`Variable: %s`
			`Flags: %s %s`
			`#`
			`[default-only-param-set]`
			`WARNING: A user-supplied value attempted to override the default-only MCA`
			`variable named "%s".`

			`The user-supplied value was ignored.`
			`#`
			`[missing-param-file]`
			`Process %d Unable to locate the variable file "%s" in the following search path:`
			`%s`
			`#`
			`[deprecated-mca-env]`
			`A deprecated MCA variable value was specified in the environment or`
			`on the command line. Deprecated MCA variables should be avoided;`
			`they may disappear in future releases.`

			`Deprecated variable: %s`
			`#`
			`[deprecated-mca-cli]`
			`A deprecated MCA variable value was specified on the command line. Deprecated`
			`MCA variables should be avoided; they may disappear in future releases.`

			`Deprecated variable: %s`
			`#`
			`[deprecated-mca-file]`
			`A deprecated MCA variable value was specified in an MCA variable`
			`file. Deprecated MCA variables should be avoided; they may disappear`
			`in future releases.`

			`Deprecated variable: %s`
			`Source file: %s`
			`#`
			`[mutually-exclusive-vars]`
			`Two mutually-exclusive MCA variables were specified. This can result`
			`in undefined behavior, such as ignoring the components that the MCA`
			`variables are supposed to affect.`

			`1st MCA variable: %s`
			`Source of value: %s`
			`2nd MCA variable: %s`
			`Source of value: %s`
			`#`
			`[re-register-with-different-type]`
			`An MCA variable was re-registered with a different type (i.e., it was`
			`either originally registered as an INT and re-registered as a STRING,`
			`or it was originially registered as a STRING and re-registered as an`
			`INT). This a developer error; your job may abort.`

			`MCA variable name: %s`
			`#`
MCA: Per-RFC, add support for performance variables This commit adds an API for registering and querying performance variables (mca_base_pvar) in the MCA base. The existing MCA variable system API has been updated to reflect the new API: MCA variable groups have performance variables, and new types have been added (double, unsigned long long) to reflect what is required by the MPI_T interface. Additionally, the MCA variable group code has been split into its own set of files: mca_base_var_group.[ch]. Details of the new API can be found in doxygen comments in the header: mca_base_pvar.h. Other changes to the variable system: - Use an opal_hash_table to speed up variable/group lookup. - Clean up code associated with MCA variable types. - Registered performance variables are printed by ompi_info -a. In the future an option should be added to control this behavior. Changes to OMPI: - Added full support for the MPI_T performance variable interface. This commit was SVN r28800. 2013-07-16 20:02:13 +04:00			`[var-name-conflict]`
			`A name collision was detected on an MCA variable name. This can happen`
			`if two components try to register the same variable with slightly`
			`different name components. The conflicting variables are listed below:`

			`MCA variable name: %s`
			`New name: %s %s %s`
			`Existing name: %s %s %s`
			`#`
MCA/base: Add new MCA variable system Features: - Support for an override parameter file (openmpi-mca-param-override.conf). Variable values in this file can not be overridden by any file or environment value. - Support for boolean, unsigned, and unsigned long long variables. - Support for true/false values. - Support for enumerations on integer variables. - Support for MPIT scope, verbosity, and binding. - Support for command line source. - Support for setting variable source via the environment using OMPI_MCA_SOURCE_<var name>=source (either command or file:filename) - Cleaner API. - Support for variable groups (equivalent to MPIT categories). Notes: - Variables must be created with a backing store (char *, int , or bool *) that must live at least as long as the variable. - Creating a variable with the MCA_BASE_VAR_FLAG_SETTABLE enables the use of mca_base_var_set_value() to change the value. - String values are duplicated when the variable is registered. It is up to the caller to free the original value if necessary. The new value will be freed by the mca_base_var system and must not be freed by the user. - Variables with constant scope may not be settable. - Variable groups (and all associated variables) are deregistered when the component is closed or the component repository item is freed. This prevents a segmentation fault from accessing a variable after its component is unloaded. - After some discussion we decided we should remove the automatic registration of component priority variables. Few component actually made use of this feature. - The enumerator interface was updated to be general enough to handle future uses of the interface. - The code to generate ompi_info output has been moved into the MCA variable system. See mca_base_var_dump(). opal: update core and components to mca_base_var system orte: update core and components to mca_base_var system ompi: update core and components to mca_base_var system This commit also modifies the rmaps framework. The following variables were moved from ppr and lama: rmaps_base_pernode, rmaps_base_n_pernode, rmaps_base_n_persocket. Both lama and ppr create synonyms for these variables. This commit was SVN r28236. 2013-03-28 01:09:41 +04:00			`[overridden-param-set]`
			`WARNING: A user-supplied value attempted to set a variable that is set`
			`in the override variable file (openmpi-mca-params-override.conf).`

			`Variable: %s`

			`The user-supplied value was ignored.`
			`#`
			`[invalid-value]`
			`An invalid value was supplied for an enum variable.`

			`Variable : %s`
			`Value : %s`
			`#`
			`[invalid-value-enum]`
			`An invalid value was supplied for an enum variable.`

			`Variable : %s`
			`Value : %s`
			`Valid values : %s`
			`#`
			`[environment-only-param]`
			`WARNING: The special MCA parameter "%s" was set in`
			`an unexpected way, and is likely not working the way you want it to.`

			`Specifically, this MCA parameter is "special" in that it can only be`
			`set in the environment. Setting this value in a file -- and sometimes`
			`even on the command line -- will not work as intended. The only way`
			`to set this value is to set "OMPI_MCA_%s" in the environment before`
			`starting your job.`

			`Value: %s`
			`Source: %s`