summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTomas Mraz <tmraz@fedoraproject.org>2019-09-17 13:34:51 +0200
committerTomas Mraz <tmraz@fedoraproject.org>2019-09-17 13:34:51 +0200
commit2c758340de77993315828bee34dd9fac609f2fe1 (patch)
treeb56d099e41fdd684b2414b4e94256d9bb8c09c19
parent1d29b70de605ad1d291fdd7d5d2caea0f5996c56 (diff)
downloadlibpwquality-git-2c758340de77993315828bee34dd9fac609f2fe1.tar.gz
Clarify the pwquality_strerror() manual in regards to auxerror handling.
The pwquality_strerror() must not be called with the same auxerror data twice. Make it clear in the manpage.
-rw-r--r--doc/man/pwquality.3.pod4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/man/pwquality.3.pod b/doc/man/pwquality.3.pod
index 410b05e..648a85f 100644
--- a/doc/man/pwquality.3.pod
+++ b/doc/man/pwquality.3.pod
@@ -78,7 +78,9 @@ set higher, the score for the same passwords will be lower.
Function I<pwquality_strerror()> translates the B<errcode> and B<auxerror> auxiliary
data into localized text message. If B<buf> is NULL the function uses an internal static
buffer which makes the function non-reentrant in that case. The returned pointer is not
-guaranteed to point to the B<buf>.
+guaranteed to point to the B<buf>. The function handles deallocation of eventual
+B<auxerror> data passed into it, thus it must not be called twice with the same
+B<auxerror> data.
=head1 RETURN VALUES