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 a67b85ec3d3095845323026e7d594d99a999728e..f9813f92dd5c00956849e08df96d416396e8f0b0 100644 (file)
--- 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