Skip to content

Commit

Permalink
Merge pull request #521 from davidozog/pr/team_get_config_clarify-output
Browse files Browse the repository at this point in the history
team_get_config: return the *current* config values
  • Loading branch information
jdinan authored Aug 23, 2024
2 parents 3311531 + 0aa81be commit a41b519
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
5 changes: 5 additions & 0 deletions content/backmatter.tex
Original file line number Diff line number Diff line change
Expand Up @@ -709,6 +709,11 @@ \section{Version 1.6}
additional arguments.
\ChangelogRef{subsec:shmem_pcontrol}
%
\item Clarified that \FUNC{shmem\_team\_get\_config} returns the current
configuration values, which may differ from the values assigned at the
time of the team's creation.
\ChangelogRef{subsec:shmem_team_get_config}
%
\item Clarified the behavior of \FUNC{shmem\_team\_get\_config} when the
\VAR{config\_mask} is 0 and/or the \VAR{config} argument is a null pointer.
\ChangelogRef{subsec:shmem_team_get_config}
Expand Down
4 changes: 4 additions & 0 deletions content/shmem_team_get_config.tex
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@
\FUNC{shmem\_team\_get\_config} returns through the \VAR{config} argument
the configuration parameters as described by the mask, which were assigned according
to input configuration parameters when the team was created.
The output \VAR{config} argument indicates the \openshmem library's
parameter values at the time \FUNC{shmem\_team\_get\_config} is called.
These values may differ from the parameter values that were assigned at the
time of the team's creation.

If \VAR{team} compares equal to \LibConstRef{SHMEM\_TEAM\_INVALID},
then no operation is performed.
Expand Down

0 comments on commit a41b519

Please sign in to comment.