diff options
author | Roland Dreier <rolandd@cisco.com> | 2005-12-15 21:46:47 +0000 |
---|---|---|
committer | Roland Dreier <rolandd@cisco.com> | 2006-11-09 11:35:58 -0800 |
commit | 6292fb610da5244e28b05a1dadc1f7683902270f (patch) | |
tree | 65e5ce4d93be94938d56fb3d0203f035bfa18f8a | |
parent | c4ecbe83483cdaf86f85b497dae6b4410d469c64 (diff) | |
download | libibverbs-6292fb610da5244e28b05a1dadc1f7683902270f.tar.gz |
Improve ibv_free_device_list() documentation
Signed-off-by: Roland Dreier <rolandd@cisco.com>
-rw-r--r-- | ChangeLog | 3 | ||||
-rw-r--r-- | include/infiniband/verbs.h | 5 |
2 files changed, 7 insertions, 1 deletions
@@ -1,5 +1,8 @@ 2005-12-15 Roland Dreier <rdreier@cisco.com> + * include/infiniband/verbs.h: Document that devices must be opened + before calling ibv_free_device_list(). + * src/verbs.c (ibv_create_srq): Not all provider libraries will support SRQs, so check if the create_srq method is defined before calling it. (Based on a patch from Shirley Ma <xma@us.ibm.com>) diff --git a/include/infiniband/verbs.h b/include/infiniband/verbs.h index cd86b2a..ae0666b 100644 --- a/include/infiniband/verbs.h +++ b/include/infiniband/verbs.h @@ -597,7 +597,10 @@ extern struct ibv_device **ibv_get_device_list(int *num_devices); /** * ibv_free_device_list - Free list from ibv_get_device_list() * - * Free an array of devices returned from ibv_get_device_list() + * Free an array of devices returned from ibv_get_device_list(). Once + * the array is freed, pointers to devices that were not opened with + * ibv_open_device() are no longer valid. Client code must open all + * devices it intends to use before calling ibv_free_device_list(). */ extern void ibv_free_device_list(struct ibv_device **list); |