API: clarify collective mem map destruction

openucx · Feb 20, 2024 · 8481fd3 · 8481fd3
1 parent 3db29e9
commit 8481fd3
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/ucc/api/ucc.h b/src/ucc/api/ucc.h
@@ -1881,6 +1881,8 @@ typedef struct ucc_coll_args {
                                                   exchanged with the team
                                                   associated with the collective
                                                   via an allgather operation.
+                                                  Memory is unmapped during
+                                                  context destruction.
                                                   It is recommended to use this
                                                   option sparingly due to the
                                                   increased overhead. Not necessary