[#3940] address review comments

diff --git a/doc/sphinx/arm/shell.rst b/doc/sphinx/arm/shell.rst
index 27b1c6f2d004ca842bb56e7e08c06f6a3e39b002..3c1f76f8499e8f89616c03547ba2e526493c6616 100644 (file)
--- 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 d29cb1113c03449d20dbf2d1c0e4ff899f6bdca7..0dd3e4180402c92c3a4805faf73340bfa3e2efaa 100644 (file)
--- 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 253898e6e55e3de38bcdf94cf099b4bdaedbae33..20ef78a04947c65712b965c314330bc4e21360f0 100755 (executable)
--- 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, '