]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
librados: add section docs for object operations
authorJosh Durgin <josh.durgin@inktank.com>
Mon, 3 Feb 2014 19:46:59 +0000 (11:46 -0800)
committerJosh Durgin <josh.durgin@inktank.com>
Tue, 18 Feb 2014 20:34:32 +0000 (12:34 -0800)
The doxygen end section of watch notify was accidentally moved when
these were added, so fix that at the same time.

Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
src/include/rados/librados.h

index 7dd1748da2438d07dae82045ba43216249ad050e..3ef2ffcf44ed548ffff4e08c0c651fd56d36ec4b 100644 (file)
@@ -1683,7 +1683,22 @@ int rados_unwatch(rados_ioctx_t io, const char *o, uint64_t handle);
  */
 int rados_notify(rados_ioctx_t io, const char *o, uint64_t ver, const char *buf, int buf_len);
 
-/** @} Atomic write operations */
+/** @} Watch/Notify */
+
+/**
+ * @defgroup librados_h_obj_op Object Operations
+ *
+ * A single rados operation can do multiple operations on one object
+ * atomicly. The whole operation will suceed or fail, and no partial
+ * results will be visible.
+ *
+ * Operations may be either reads, which can return data, or writes,
+ * which cannot. The effects of writes are applied and visible all at
+ * once, so an operation that sets an xattr and then checks its value
+ * will not see the updated value.
+ *
+ * @{
+ */
 
 /**
  * Create a new rados_write_op_t write operation. This will store all actions
@@ -1830,7 +1845,7 @@ int rados_aio_write_op_operate(rados_write_op_t write_op,
                                time_t *mtime);
 
 
-/** @} Watch/Notify */
+/** @} Object Operations */
 
 /**
  * Take an exclusive lock on an object.