ovsdb-idl: Improve comment.
authorBen Pfaff <blp@nicira.com>
Mon, 20 Jun 2011 21:11:14 +0000 (14:11 -0700)
committerBen Pfaff <blp@nicira.com>
Tue, 21 Jun 2011 20:01:55 +0000 (13:01 -0700)
lib/ovsdb-idl.c

index 94784bdaabfb236e10351da9adbcac983dffa7a8..f4daaed16f18cc9c60d0e0fd457b8fe9add82789 100644 (file)
@@ -1640,7 +1640,11 @@ ovsdb_idl_txn_complete(struct ovsdb_idl_txn *txn,
  * been disabled (by calling ovsdb_idl_omit()).
  *
  * Usually this function is used indirectly through one of the "set" functions
- * generated by ovsdb-idlc. */
+ * generated by ovsdb-idlc.
+ *
+ * Takes ownership of what 'datum' points to (and in some cases destroys that
+ * data before returning) but makes a copy of 'datum' itself.  (Commonly
+ * 'datum' is on the caller's stack.) */
 void
 ovsdb_idl_txn_write(const struct ovsdb_idl_row *row_,
                     const struct ovsdb_idl_column *column,