From: Sebastian Harl <sh@tokkee.org>
Date: Sat, 2 Aug 2014 10:41:37 +0000 (+0200)
Subject: data: Document the use of dynamically allocated data in expr_eval().
X-Git-Tag: sysdb-0.4.0~54
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=dde59b1a78041d3298d9d637173b1ed7ed430498;hp=5d46c40d53c7fb6aae658e08c8e8015e2be72a40;p=sysdb.git

data: Document the use of dynamically allocated data in expr_eval().
---

diff --git a/src/include/core/data.h b/src/include/core/data.h
index 8f9b282..6e4d317 100644
--- a/src/include/core/data.h
+++ b/src/include/core/data.h
@@ -145,7 +145,8 @@ enum {
  * sdb_data_expr_eval:
  * Evaluate a simple arithmetic expression on two data points. String and
  * binary data only support concatenation and all other data types only
- * support the other operators.
+ * support the other operators. The result may be allocated dynamically and
+ * has to be freed by the caller (using sdb_data_free_datum).
  *
  * The data-types of d1 and d2 have to be the same, except for the following
  * cases: