From 45077949c9aa2aa05ba190738ae8616c1ec16950 Mon Sep 17 00:00:00 2001
From: Thorsten Kukuk <kukuk@thkukuk.de>
Date: Sat, 29 Nov 2008 07:28:44 +0000
Subject: Relevant BUGIDs:

Purpose of commit: bugfix

Commit summary:
---------------

2008-11-29  Thorsten Kukuk  <kukuk@thkukuk.de>

        * doc/man/pam_getenv.3.xml: Document that application should
        not free return value.

        * doc/man/pam.3.xml: Add Note about thread-safeness of libpam
        functions.
---
 doc/man/pam.3.xml        | 6 ++++++
 doc/man/pam_getenv.3.xml | 5 +++--
 2 files changed, 9 insertions(+), 2 deletions(-)

(limited to 'doc/man')

diff --git a/doc/man/pam.3.xml b/doc/man/pam.3.xml
index 3cf71b2d..78e1cf3e 100644
--- a/doc/man/pam.3.xml
+++ b/doc/man/pam.3.xml
@@ -430,4 +430,10 @@
       </citerefentry>
     </para>
   </refsect1>
+  <refsect1 id='pam3-notes'><title>NOTES</title>
+    <para>
+      The <emphasis>libpam</emphasis> interfaces are only thread-safe if each
+      thread within the multithreaded application uses its own PAM handle.
+    </para>
+  </refsect1>
 </refentry>
diff --git a/doc/man/pam_getenv.3.xml b/doc/man/pam_getenv.3.xml
index 871e511d..7e8db015 100644
--- a/doc/man/pam_getenv.3.xml
+++ b/doc/man/pam_getenv.3.xml
@@ -33,8 +33,9 @@
       The <function>pam_getenv</function> function searches the
       PAM environment list as associated with the handle
       <emphasis>pamh</emphasis> for an item that matches the string
-      pointed to by <emphasis>name</emphasis> and returns the value
-      of the environment variable.
+      pointed to by <emphasis>name</emphasis> and returns a pointer
+      to the value of the environment variable. The application is
+      not allowed to free the data.
     </para>
   </refsect1>
 
-- 
cgit v1.2.3