Clarify docs for auth.cpp method

diff --git a/src/util/auth.cpp b/src/util/auth.cpp
index ac5139535fec63504932da2123a11161e277b655..df8940e87c03ad57542f79a9e86c95e060dcc5ee 100644 (file)
--- 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)
 {