From 254dbe7abd255075b16db35b821566ed51fa850e Mon Sep 17 00:00:00 2001
From: est31 <MTest31@outlook.com>
Date: Tue, 21 Jul 2015 18:03:59 +0200
Subject: [PATCH] Clarify docs for auth.cpp method
---
src/util/auth.cpp | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/util/auth.cpp b/src/util/auth.cpp
index ac5139535..df8940e87 100644
--- 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)
{
--
GitLab