From: Christian Marie <pingu@anchor.net.au>
Date: Fri, 13 Dec 2013 02:24:31 +0000 (+1100)
Subject: Document librados's rados_write's behaviour in reguards to return value.
X-Git-Tag: v0.75~103^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F937%2Fhead;p=ceph.git

Document librados's rados_write's behaviour in reguards to return value.
---

diff --git a/src/include/rados/librados.h b/src/include/rados/librados.h
index a67b85ec3d30..f9813f92dd5c 100644
--- a/src/include/rados/librados.h
+++ b/src/include/rados/librados.h
@@ -927,6 +927,7 @@ uint64_t rados_get_last_version(rados_ioctx_t io);
 /**
  * Write data to an object
  *
+ * @note This will never return a positive value not equal to len.
  * @param io the io context in which the write will occur
  * @param oid name of the object
  * @param buf data to write