Clarify docs for auth.cpp method

minetest · Jul 21, 2015 · 254dbe7 · 254dbe7
1 parent a57d83b
commit 254dbe7
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/src/util/auth.cpp b/src/util/auth.cpp
@@ -57,9 +57,9 @@ void getSRPVerifier(const std::string &name,
 }
 
 // Get a db-ready SRP verifier
-// The salt param is only modifyable by this method so that you can free it
-// if it was allocated. You shouldn't use it for other purposes, as you will
-// need the contents of salt_len too.
+// If the salt param is NULL, one is automatically generated.
+// Please free() it afterwards. You shouldn't use it for other purposes,
+// as you will need the contents of salt_len too.
 inline static std::string getSRPVerifier(const std::string &name,
 	const std::string &password, char ** salt, size_t salt_len)
 {