Skip to content

Commit 8d49d49

Browse files
committed
Update description of get_infos
Signed-off-by: Aurelien Bouteiller <bouteill@icl.utk.edu>
1 parent 4bf6151 commit 8d49d49

1 file changed

Lines changed: 14 additions & 6 deletions

File tree

parsec/utils/info.h

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -130,9 +130,13 @@ parsec_info_clear(parserc_info_t *info);
130130
* associated with any keys), but is always returns a reference to a
131131
* valid info object.
132132
*
133-
* Key-values added to the info object will be implicitly applied to
134-
* the context, that is, the info is a reference to the info object
135-
* internally held by the context.
133+
* Key-values added, modified, or removed to/from the info object will
134+
* be implicitly applied to the context, that is, behavior for calls
135+
* using that context may be altered accordingly to the set key-values.
136+
*
137+
* The returned info is a reference to the info object internally held
138+
* by the context. The Info object should never be freed, and it ceases
139+
* to be a valid reference when the concext has been freed.
136140
*/
137141
parsec_context_get_info(parsec_context_t *ctx, parsec_info_t **info);
138142

@@ -149,9 +153,13 @@ parsec_context_get_info(parsec_context_t *ctx, parsec_info_t **info);
149153
* associated with any keys), but is always returns a reference to a
150154
* valid info object.
151155
*
152-
* Key-values added to the info object will be implicitly applied to
153-
* the taskpool, that is, the info is a reference to the info object
154-
* internally held by the taskpool.
156+
* Key-values added, modified, or removed to/from the info object will
157+
* be implicitly applied to the taskpool, that is, behavior for calls
158+
* using that taskpool may be altered accordingly to the set key-values.
159+
*
160+
* The returned info is a reference to the info object internally held
161+
* by the taskpool. The Info object should never be freed, and it ceases
162+
* to be a valid reference when the taskpool has been freed.
155163
*/
156164
parsec_taskpool_get_info(parsec_taskpool_t *tp, parsec_info_t **info);
157165

0 commit comments

Comments
 (0)