From: Lennart Poettering <lennart@poettering.net>
Date: Mon, 14 May 2012 20:41:17 +0000 (+0200)
Subject: sd-login: update header docs a bit
X-Git-Tag: v183~112
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=commitdiff_plain;h=ee1f44bd9a63e776810a31bd8394e8d481b6c34d

sd-login: update header docs a bit
---

diff --git a/src/systemd/sd-login.h b/src/systemd/sd-login.h
index f8c3c6913..0a6d6ffda 100644
--- a/src/systemd/sd-login.h
+++ b/src/systemd/sd-login.h
@@ -34,7 +34,9 @@ extern "C" {
  * Instead of returning an empty string array or empty uid array, we
  * may return NULL.
  *
- * Free the data we return with libc free().
+ * Free the data the library returns with libc free(). String arrays
+ * are NULL terminated and you need to free the array itself in
+ * addition to the strings contained.
  *
  * We return error codes as negative errno, kernel-style. 0 or
  * positive on success.