lib-storage: mail-user: Clarify mail_user_get_home() usage string

Explicitly comment about returned string lifetime.

diff --git a/src/lib-storage/mail-user.h b/src/lib-storage/mail-user.h
index 86005092228e2735f98d38fb97d6caa85c9abdc3..1b4d16918e3ed2c69db8f334ed38d4e6ab357791 100644 (file)
--- a/src/lib-storage/mail-user.h
+++ b/src/lib-storage/mail-user.h
@@ -159,7 +159,8 @@ mail_user_var_expand_table(struct mail_user *user);
 void mail_user_set_home(struct mail_user *user, const char *home);
 /* Get the home directory for the user. Returns 1 if home directory looked up
    successfully, 0 if there is no home directory (either user doesn't exist or
-   has no home directory) or -1 if lookup failed. */
+   has no home directory) or -1 if lookup failed. The returned home string
+   is valid until the user is freed. */
 int mail_user_get_home(struct mail_user *user, const char **home_r);
 /* Appends path + file prefix for creating a temporary file.
    The file prefix doesn't contain any uniqueness. */