diff mbox

[librdmacm,1/3] man: rdma_post_*(): memory region is optional only with IBV_SEND_INLINE.

Message ID dfe767c849fc9472bd87c723c401052b89d40d7c.1376746185.git.ydroneaud@opteya.com (mailing list archive)
State Rejected
Headers show

Commit Message

Yann Droneaud Aug. 17, 2013, 1:38 p.m. UTC
State explicitly when MR argument is optional.

MR should be a mandatory argument to rdma_post_*() functions.

Signed-off-by: Yann Droneaud <ydroneaud@opteya.com>
---
 man/rdma_post_send.3    | 2 +-
 man/rdma_post_ud_send.3 | 2 +-
 man/rdma_post_write.3   | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

Comments

Yann Droneaud Aug. 17, 2013, 1:51 p.m. UTC | #1
Le 17.08.2013 15:38, Yann Droneaud a écrit :
> State explicitly when MR argument is optional.
> 
> MR should be a mandatory argument to rdma_post_*() functions.
> 
> Signed-off-by: Yann Droneaud <ydroneaud@opteya.com>
> ---

...

>  man/rdma_post_ud_send.3 | 2 +-

...

> diff --git a/man/rdma_post_ud_send.3 b/man/rdma_post_ud_send.3
> index f8e2ada..dd40b8a 100644
> --- a/man/rdma_post_ud_send.3
> +++ b/man/rdma_post_ud_send.3
> @@ -24,7 +24,7 @@ The address of the memory buffer to post.
>  .IP "length" 12
>  The length of the memory buffer.
>  .IP "mr" 12
> -Optional registered memory region associated with the posted buffer.
> +Registered memory region associated with the posted buffer. Optional
> if IBV_SEND_INLINE_FLAG is used.

s/_FLAG/ flag/
diff mbox

Patch

diff --git a/man/rdma_post_send.3 b/man/rdma_post_send.3
index 82bcf37..bf35716 100644
--- a/man/rdma_post_send.3
+++ b/man/rdma_post_send.3
@@ -22,7 +22,7 @@  The address of the memory buffer to post.
 .IP "length" 12
 The length of the memory buffer.
 .IP "mr" 12
-Optional registered memory region associated with the posted buffer.
+Registered memory region associated with the posted buffer. Optional if IBV_SEND_INLINE flag is used.
 .IP "flags" 12
 Optional flags used to control the send operation.
 .SH "DESCRIPTION"
diff --git a/man/rdma_post_ud_send.3 b/man/rdma_post_ud_send.3
index f8e2ada..dd40b8a 100644
--- a/man/rdma_post_ud_send.3
+++ b/man/rdma_post_ud_send.3
@@ -24,7 +24,7 @@  The address of the memory buffer to post.
 .IP "length" 12
 The length of the memory buffer.
 .IP "mr" 12
-Optional registered memory region associated with the posted buffer.
+Registered memory region associated with the posted buffer. Optional if IBV_SEND_INLINE_FLAG is used.
 .IP "flags" 12
 Optional flags used to control the send operation.
 .IP "ah" 12
diff --git a/man/rdma_post_write.3 b/man/rdma_post_write.3
index 896996c..3fbd8a1 100644
--- a/man/rdma_post_write.3
+++ b/man/rdma_post_write.3
@@ -24,7 +24,7 @@  The local address of the source of the write request.
 .IP "length" 12
 The length of the write operation.
 .IP "mr" 12
-Optional memory region associated with the local buffer.
+Registered memory region associated with the local buffer. Optional if IBV_SEND_INLINE flag is used.
 .IP "flags" 12
 Optional flags used to control the write operation.
 .IP "remote_addr" 12