UCP/API: CR comments

openucx · Nov 20, 2020 · 26d3040 · 26d3040
1 parent 5c52408
commit 26d3040
Showing 1 changed file with 11 additions and 5 deletions.
diff --git a/src/ucp/api/ucp.h b/src/ucp/api/ucp.h
@@ -1420,12 +1420,18 @@ typedef struct {
 
     /**
      * Pointer to the information where received data details are stored
-     * in case of immediate completion of receive operation.
+     * in case of immediate completion of receive operation. User has to provide
+     * a pointer to valid memory/variable which will be updated on function
+     * return.
      */
     union {
-        size_t              *length;
-        ucp_tag_recv_info_t *tag;
-    }             recv_info;
+        size_t              *length;   /* Length of received message in bytes.
+                                          Relevant for non-tagged receive
+                                          operations. */
+        ucp_tag_recv_info_t *tag_info; /* Information about received message
+                                          relevant for @a ucp_tag_recv_nbx
+                                          function. */
+    } recv_info;
 } ucp_request_param_t;
 
 
@@ -3386,7 +3392,7 @@ ucs_status_t ucp_tag_recv_nbr(ucp_worker_h worker, void *buffer, size_t count,
  *
  * @return NULL                 - The receive operation was completed
  *                                immediately. In this case, if
- *                                @a param->recv_info.tag is specified in the
+ *                                @a param->recv_info.tag_info is specified in the
  *                                @a param, the value pointed by it is updated
  *                                with the information about the received message.
  * @return UCS_PTR_IS_ERR(_ptr) - The receive operation failed.