sd-login: update header docs a bit

diff --git a/src/systemd/sd-login.h b/src/systemd/sd-login.h
index f8c3c6913a04cff173a2c4408804046b21701e69..0a6d6ffdaa18ee0b2a8d5eef45a98517a3db675b 100644 (file)
--- 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.