From d62120ed7cfa99dec0e66e562f20fb32987c5980 Mon Sep 17 00:00:00 2001
From: Jeff Squyres <jsquyres@cisco.com>
Date: Wed, 19 May 2021 11:38:01 -0700
Subject: pam.conf: clarify default action for unspecified return codes

Add short blurbs explaining that if a return code is not specified in
the "[value1=action1 value2=action2 ...]" form and "default=action" is
not specified, that return code's action defaults to "bad".

Signed-off-by: Jeff Squyres <jsquyres@cisco.com>
---
 doc/man/pam.conf-syntax.xml | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

(limited to 'doc')

diff --git a/doc/man/pam.conf-syntax.xml b/doc/man/pam.conf-syntax.xml
index 864a580d..5112f930 100644
--- a/doc/man/pam.conf-syntax.xml
+++ b/doc/man/pam.conf-syntax.xml
@@ -265,7 +265,8 @@
              this action indicates that the return code should be thought
              of as indicative of the module failing. If this module is the
              first in the stack to fail, its status value will be used for
-             that of the whole stack.
+             that of the whole stack.  This is the default action for
+             all return codes.
           </para>
         </listitem>
       </varlistentry>
@@ -335,6 +336,13 @@
       </varlistentry>
     </variablelist>
 
+    <para>
+      If a return code's action is not specifically defined via a
+      <emphasis>valueN</emphasis> token, and the
+      <emphasis>default</emphasis> value is not specified, that return
+      code's action defaults to <emphasis>bad</emphasis>.
+    </para>
+
     <para>
       Each of the four keywords: required; requisite; sufficient; and
       optional, have an equivalent expression in terms of the [...]
-- 
cgit v1.2.3