From: Piotrek Zadroga <piotrek@isc.org>
Date: Tue, 17 Jun 2025 17:16:48 +0000 (+0200)
Subject: [#3940] address review comments
X-Git-Tag: Kea-3.0.0~74
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=eef015c2bbdf9966bff8583fa23991e2acf36562;p=thirdparty%2Fkea.git

[#3940] address review comments
---

diff --git a/doc/sphinx/arm/shell.rst b/doc/sphinx/arm/shell.rst
index 27b1c6f2d0..3c1f76f849 100644
--- a/doc/sphinx/arm/shell.rst
+++ b/doc/sphinx/arm/shell.rst
@@ -62,9 +62,10 @@ where:
    If not specified but the user ID is specified, an empty password is used.
    If used together with ``--auth-password-file``, it is disregarded.
 
--  ``--auth-password-file`` specifies a file which first line will be read to
-   retrieve the password for basic HTTP authentication. This flag takes precedence
-   over ``--auth-password`` flag. Caution is advised when setting file permissions
+-  ``--auth-password-file`` specifies a text file whose first line contains
+   the password to be used for basic HTTP authentication. This flag takes
+   precedence over ``--auth-password`` flag.
+   Caution is advised when setting file permissions
    for the file containing the password. Access to the file should be as strict as
    possible and limited only to the Kea administrators.
 
diff --git a/doc/sphinx/man/kea-shell.8.rst b/doc/sphinx/man/kea-shell.8.rst
index d29cb1113c..0dd3e41804 100644
--- a/doc/sphinx/man/kea-shell.8.rst
+++ b/doc/sphinx/man/kea-shell.8.rst
@@ -78,8 +78,8 @@ The arguments are as follows:
    If used together with ``--auth-password-file``, it is disregarded.
 
 ``--auth-password-file``
-   Specifies a file which first line will be read to retrieve
-   the password for basic HTTP authentication. This flag takes precedence
+   Specifies a text file whose first line contains the password to be used
+   for basic HTTP authentication. This flag takes precedence
    over ``--auth-password`` flag.
 
 ``--timeout``
diff --git a/src/bin/shell/kea-shell.in b/src/bin/shell/kea-shell.in
index 253898e6e5..20ef78a049 100755
--- a/src/bin/shell/kea-shell.in
+++ b/src/bin/shell/kea-shell.in
@@ -77,12 +77,12 @@ def shell_body():
                         help='Basic HTTP authentication user')
     parser.add_argument('--auth-password', type=str, default='',
                         help='Basic HTTP authentication password. If used '
-                             'together with --auth-password-file, '
+                             'together with "--auth-password-file", '
                              'it is disregarded.')
     parser.add_argument('--auth-password-file', type=str, default='',
-                        help='A file which first line will be read to retrieve '
-                             'the password for basic HTTP authentication. This flag '
-                             'takes precedence over --auth-password.')
+                        help='A text file whose first line contains the password '
+                             'to be used for basic HTTP authentication. This flag '
+                             'takes precedence over "--auth-password" flag.')
     parser.add_argument('command', type=str, nargs="?",
                         default='list-commands',
                         help='command to be executed. If not specified, '