From: Ben Pfaff <blp@nicira.com>
Date: Mon, 20 Jun 2011 21:11:14 +0000 (-0700)
Subject: ovsdb-idl: Improve comment.
X-Git-Tag: v1.2.0~150
X-Git-Url: http://git.onelab.eu/?a=commitdiff_plain;h=27a325164faa2539ce9b713a250fc3c5a7f2e40d;p=sliver-openvswitch.git

ovsdb-idl: Improve comment.
---

diff --git a/lib/ovsdb-idl.c b/lib/ovsdb-idl.c
index 94784bdaa..f4daaed16 100644
--- a/lib/ovsdb-idl.c
+++ b/lib/ovsdb-idl.c
@@ -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,