comment potentially-confusing use of struct crypt_data type

[musl] / src / crypt / crypt_r.c

diff --git a/src/crypt/crypt_r.c b/src/crypt/crypt_r.c
index 3257e8b..5982c4c 100644 (file)
--- a/src/crypt/crypt_r.c
+++ b/src/crypt/crypt_r.c
@@ -11,6 +11,10 @@ char *__crypt_sha512(const char *, const char *, char *);
 
 char *__crypt_r(const char *key, const char *salt, struct crypt_data *data)
 {
+       /* Per the crypt_r API, the caller has provided a pointer to
+        * struct crypt_data; however, this implementation does not
+        * use the structure to store any internal state, and treats
+        * it purely as a char buffer for storing the result. */
        char *output = (char *)data;
        if (salt[0] == '$' && salt[1] && salt[2]) {
                if (salt[1] == '1' && salt[2] == '$')