From 017c3ff13d1bb7804799deadd8f58b92eba7979e Mon Sep 17 00:00:00 2001
From: Tomas Mraz <tmraz@fedoraproject.org>
Date: Wed, 2 Dec 2020 10:09:17 +0100
Subject: Clarify the effect of 'done' in documentation

The done action does not terminate the stack processing in case
there is a failing module with bad action up in the stack.

Fixes #307

* doc/man/pam.conf-syntax.xml: Clarify the effect of 'done'.
---
 doc/man/pam.conf-syntax.xml | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

(limited to 'doc')

diff --git a/doc/man/pam.conf-syntax.xml b/doc/man/pam.conf-syntax.xml
index 7b4edbf2..864a580d 100644
--- a/doc/man/pam.conf-syntax.xml
+++ b/doc/man/pam.conf-syntax.xml
@@ -273,8 +273,9 @@
         <term>die</term>
         <listitem>
            <para>
-             equivalent to bad with the side effect of terminating the
-             module stack and PAM immediately returning to the application.
+             equivalent to <emphasis>bad</emphasis> with the side effect of
+             terminating the module stack and PAM immediately returning to
+             the application.
           </para>
         </listitem>
       </varlistentry>
@@ -297,8 +298,9 @@
         <term>done</term>
         <listitem>
            <para>
-             equivalent to ok with the side effect of terminating the module
-             stack and PAM immediately returning to the application.
+             equivalent to <emphasis>ok</emphasis> with the side effect of
+             terminating the module stack and PAM immediately returning to the
+             application unless there was a non-ignored module failure before.
           </para>
         </listitem>
       </varlistentry>
-- 
cgit v1.2.3