Skip to content

Commit c5d3ee5

Browse files
valentin petrovmanjugv
valentin petrov
andauthored
CORE: clarify ctx_cfg_modify semantics (#403) (#408)
Co-authored-by: Manjunath Gorentla Venkata <manjugv@users.noreply.github.com> Signed-off-by: Valentin Petrov <valentinp@nvidia.com> Co-authored-by: Manjunath Gorentla Venkata <manjugv@users.noreply.github.com>
1 parent 71eee8e commit c5d3ee5

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

src/ucc/api/ucc.h

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1026,10 +1026,11 @@ void ucc_context_config_print(const ucc_context_config_h config, FILE *stream,
10261026
* @brief The @ref ucc_context_config_modify routine modifies the runtime configuration
10271027
* of UCC context (optionally for a given CLS)
10281028
*
1029-
* @param [in] config Pointer to the configuration descriptor to be modified
1030-
* @param [in] cls Comma separated list of CLS or NULL. If NULL then core context config is modified.
1031-
* @param [in] name Configuration variable to be modified
1032-
* @param [in] value Configuration value to set
1029+
* @param [in] config Pointer to the configuration descriptor to be modified
1030+
* @param [in] component CL/TL component (e.g. "tl/ucp" or "cl/basic") or NULL.
1031+
If NULL then core context config is modified.
1032+
* @param [in] name Configuration variable to be modified
1033+
* @param [in] value Configuration value to set
10331034
*
10341035
* @parblock
10351036
*
@@ -1044,7 +1045,7 @@ void ucc_context_config_print(const ucc_context_config_h config, FILE *stream,
10441045
*/
10451046

10461047
ucc_status_t ucc_context_config_modify(ucc_context_config_h config,
1047-
const char *cls, const char *name,
1048+
const char *component, const char *name,
10481049
const char *value);
10491050

10501051
/**

0 commit comments

Comments
 (0)