From f9e2e5c4e0a0d5245ca46f73090f9d39a70369d9 Mon Sep 17 00:00:00 2001
From: lifecrisis <15251574+lifecrisis@users.noreply.github.com>
Date: Fri, 6 Sep 2019 17:09:30 -0400
Subject: [PATCH] Update a function comment

The function comment for "_pam_await_timer()" does not mention the
intended behavior of prioritizing the "PAM_FAIL_DELAY" item.

I updated the comment to make this intention clear.
---
 libpam/pam_delay.c | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/libpam/pam_delay.c b/libpam/pam_delay.c
index 972e72b6..8a2be7aa 100644
--- a/libpam/pam_delay.c
+++ b/libpam/pam_delay.c
@@ -79,9 +79,11 @@ static unsigned int _pam_compute_delay(unsigned int seed, unsigned int base)
 }
 
 /* **********************************************************************
- * the following function sleeps for a random time. The actual time
- * slept is computed above.. It is based on the requested time but will
- * differ by up to +/- 50%.
+ * By default, the following function sleeps for a random time. The
+ * actual time slept is computed above. It is based on the requested
+ * time but will differ by up to +/- 50%. If the PAM_FAIL_DELAY item is
+ * set by the client, this function will call the function referenced by
+ * that item, overriding the default behavior.
  */
 
 void _pam_await_timer(pam_handle_t *pamh, int status)
-- 
2.40.0