From: Karel Zak <kzak@redhat.com>
Date: Mon, 30 Jun 2014 12:14:34 +0000 (+0200)
Subject: libsmartcols: add note about deallocations
X-Git-Tag: v2.25-rc2~16
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3175f0355269ee558d8ca1f21b429a4beb04033b;p=thirdparty%2Futil-linux.git

libsmartcols: add note about deallocations

Signed-off-by: Karel Zak <kzak@redhat.com>
---

diff --git a/libsmartcols/src/column.c b/libsmartcols/src/column.c
index 7ba284c6e0..b3dd06ef87 100644
--- a/libsmartcols/src/column.c
+++ b/libsmartcols/src/column.c
@@ -60,7 +60,8 @@ void scols_ref_column(struct libscols_column *cl)
  * scols_unref_column:
  * @cl: a pointer to a struct libscols_column instance
  *
- * Decreases the refcount of @cl.
+ * Decreases the refcount of @cl. When the count falls to zero, the instance
+ * is automatically deallocated.
  */
 void scols_unref_column(struct libscols_column *cl)
 {
diff --git a/libsmartcols/src/line.c b/libsmartcols/src/line.c
index 0ed765dcdf..ab2f191b39 100644
--- a/libsmartcols/src/line.c
+++ b/libsmartcols/src/line.c
@@ -66,7 +66,8 @@ void scols_ref_line(struct libscols_line *ln)
  * scols_unref_line:
  * @ln: a pointer to a struct libscols_line instance
  *
- * Decreases the refcount of @ln.
+ * Decreases the refcount of @ln. When the count falls to zero, the instance
+ * is automatically deallocated.
  */
 void scols_unref_line(struct libscols_line *ln)
 {
diff --git a/libsmartcols/src/table.c b/libsmartcols/src/table.c
index 53590038aa..8c404f8581 100644
--- a/libsmartcols/src/table.c
+++ b/libsmartcols/src/table.c
@@ -77,7 +77,8 @@ void scols_ref_table(struct libscols_table *tb)
  * scols_unref_table:
  * @tb: a pointer to a struct libscols_table instance
  *
- * Decreases the refcount of @tb.
+ * Decreases the refcount of @tb. When the count falls to zero, the instance
+ * is automatically deallocated.
  */
 void scols_unref_table(struct libscols_table *tb)
 {