chiark / gitweb /
sd-login: update header docs a bit
authorLennart Poettering <lennart@poettering.net>
Mon, 14 May 2012 20:41:17 +0000 (22:41 +0200)
committerLennart Poettering <lennart@poettering.net>
Mon, 14 May 2012 20:41:30 +0000 (22:41 +0200)
src/systemd/sd-login.h

index f8c3c69..0a6d6ff 100644 (file)
@@ -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.