]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
librados.h: update rados_object_list_next documentation for key/locator
authorSamuel Just <sam.just@inktank.com>
Tue, 29 May 2012 17:30:51 +0000 (10:30 -0700)
committerSamuel Just <sam.just@inktank.com>
Tue, 29 May 2012 18:23:20 +0000 (11:23 -0700)
*entry and *key don't need to be freed, and are only valid until the
next call to rados_objects_list_*.

Signed-off-by: Samuel Just <sam.just@inktank.com>
src/include/rados/librados.h

index c401dba253045ad7ae2e5a5aeb1ec322ec2df624..9f723f79394b19735c885b4c6a92498d210c6da2 100644 (file)
@@ -601,9 +601,11 @@ int rados_objects_list_open(rados_ioctx_t io, rados_list_ctx_t *ctx);
 /**
  * Get the next object name and locator in the pool
  *
+ * *entry and *key are valid until next call to rados_objects_list_*
+ *
  * @param ctx iterator marking where you are in the listing
- * @param entry where to store the name of the entry (caller must free)
- * @param key where to store the object locator (set to NULL to ignore) (caller must free)
+ * @param entry where to store the name of the entry
+ * @param key where to store the object locator (set to NULL to ignore)
  * @returns 0 on success, negative error code on failure
  * @returns -ENOENT when there are no more objects to list
  */