From patchwork Fri Mar 29 18:21:19 2013 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ira Weiny X-Patchwork-Id: 2366441 X-Patchwork-Delegate: hal@mellanox.com Return-Path: X-Original-To: patchwork-linux-rdma@patchwork.kernel.org Delivered-To: patchwork-process-083081@patchwork2.kernel.org Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by patchwork2.kernel.org (Postfix) with ESMTP id 61EE9DFB79 for ; Fri, 29 Mar 2013 18:21:25 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1756282Ab3C2SVY (ORCPT ); Fri, 29 Mar 2013 14:21:24 -0400 Received: from mga02.intel.com ([134.134.136.20]:4765 "EHLO mga02.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1755476Ab3C2SVX (ORCPT ); Fri, 29 Mar 2013 14:21:23 -0400 Received: from orsmga001.jf.intel.com ([10.7.209.18]) by orsmga101.jf.intel.com with ESMTP; 29 Mar 2013 11:21:22 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="4.87,374,1363158000"; d="scan'208";a="286337508" Received: from scvm10.sc.intel.com ([10.82.195.27]) by orsmga001.jf.intel.com with SMTP; 29 Mar 2013 11:21:19 -0700 Date: Fri, 29 Mar 2013 11:21:19 -0700 From: Ira Weiny To: Hal Rosenstock Cc: linux-rdma@vger.kernel.org Subject: [PATCH] libibumad: document the setting of errno for umad_send and umad_recv Message-Id: <20130329112119.1bb9ee1f7e687fc40c7a841d@intel.com> X-Mailer: Sylpheed 3.3.0 (GTK+ 2.18.9; x86_64-unknown-linux-gnu) Mime-Version: 1.0 Sender: linux-rdma-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-rdma@vger.kernel.org Signed-off-by: Ira Weiny --- man/umad_recv.3 | 3 ++- man/umad_send.3 | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/man/umad_recv.3 b/man/umad_recv.3 index e233411..56e4ca7 100644 --- a/man/umad_recv.3 +++ b/man/umad_recv.3 @@ -55,7 +55,8 @@ be returned. .SH "RETURN VALUE" .B umad_recv() -returns non negative receiving agentid on success, and a negative value on error as follows: +on success return the agentid; on error, errno is set and a negative value is +returned as follows: -EINVAL invalid port handle or agentid or *length is less than the minimum supported -EIO receive operation failed -EWOULDBLOCK non blocking read can't be fulfilled diff --git a/man/umad_send.3 b/man/umad_send.3 index feb33af..b85bc56 100644 --- a/man/umad_send.3 +++ b/man/umad_send.3 @@ -39,7 +39,8 @@ makes kernel wait forever for the reply. indicates the number of times the MAD will be retried before giving up. .SH "RETURN VALUE" .B umad_send() -returns 0 on success, and a negative value on error as follows: +returns 0 on success; on error, errno is set and a negative value is returned +as follows: -EINVAL invalid port handle or agentid -EIO send operation failed .SH "AUTHOR"