From: David Reynolds <david-gqc3UtWaqJ5Wk0Htik3J/w@public.gmane.org>
To: linux-rdma-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
Cc: David Reynolds <david-gqc3UtWaqJ5Wk0Htik3J/w@public.gmane.org>
Subject: [PATCH rdma-core] librdmacm: Fix incorrect return value/type in a few man pages
Date: Fri, 30 Jun 2017 18:30:26 -0400 [thread overview]
Message-ID: <20170630223026.57939-1-david@omnibond.com> (raw)
Signed-off-by: David Reynolds <david-gqc3UtWaqJ5Wk0Htik3J/w@public.gmane.org>
---
librdmacm/man/rdma_dereg_mr.3 | 2 +-
librdmacm/man/rdma_destroy_event_channel.3 | 3 +--
librdmacm/man/rdma_destroy_srq.3 | 3 +--
3 files changed, 3 insertions(+), 5 deletions(-)
diff --git a/librdmacm/man/rdma_dereg_mr.3 b/librdmacm/man/rdma_dereg_mr.3
index 1fe936b2..893eb14b 100644
--- a/librdmacm/man/rdma_dereg_mr.3
+++ b/librdmacm/man/rdma_dereg_mr.3
@@ -5,7 +5,7 @@ rdma_dereg_mr \- deregisters a registered memory region.
.SH SYNOPSIS
.B "#include <rdma/rdma_verbs.h>"
.P
-.B "struct ibv_mr *" rdma_dereg_mr
+.B "int" rdma_dereg_mr
.BI "(struct ibv_mr *" mr ");"
.SH ARGUMENTS
.IP "mr" 12
diff --git a/librdmacm/man/rdma_destroy_event_channel.3 b/librdmacm/man/rdma_destroy_event_channel.3
index 5bc982a7..5c5d663c 100644
--- a/librdmacm/man/rdma_destroy_event_channel.3
+++ b/librdmacm/man/rdma_destroy_event_channel.3
@@ -14,8 +14,7 @@ The communication channel to destroy.
Release all resources associated with an event channel and closes the
associated file descriptor.
.SH "RETURN VALUE"
-Returns 0 on success, or -1 on error. If an error occurs, errno will be
-set to indicate the failure reason.
+None
.SH "NOTES"
All rdma_cm_id's associated with the event channel must be destroyed,
and all returned events must be acked before calling this function.
diff --git a/librdmacm/man/rdma_destroy_srq.3 b/librdmacm/man/rdma_destroy_srq.3
index 5c633a8d..75c23c73 100644
--- a/librdmacm/man/rdma_destroy_srq.3
+++ b/librdmacm/man/rdma_destroy_srq.3
@@ -13,8 +13,7 @@ RDMA identifier.
.SH "DESCRIPTION"
Destroy an SRQ allocated on the rdma_cm_id.
.SH "RETURN VALUE"
-Returns 0 on success, or -1 on error. If an error occurs, errno will be
-set to indicate the failure reason.
+None
.SH "NOTES"
Users should destroy any SRQ associated with an rdma_cm_id before
destroying the ID.
--
2.11.0 (Apple Git-81)
--
To unsubscribe from this list: send the line "unsubscribe linux-rdma" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
next reply other threads:[~2017-06-30 22:30 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-06-30 22:30 David Reynolds [this message]
[not found] ` <20170630223026.57939-1-david-gqc3UtWaqJ5Wk0Htik3J/w@public.gmane.org>
2017-07-11 8:39 ` [PATCH rdma-core] librdmacm: Fix incorrect return value/type in a few man pages Leon Romanovsky
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170630223026.57939-1-david@omnibond.com \
--to=david-gqc3utwaqj5wk0htik3j/w@public.gmane.org \
--cc=linux-rdma-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox