Fix comment in libpqrcv_check_conninfo().

Previously, the comment incorrectly stated that libpqrcv_check_conninfo()
returns true or false based on the connection string check.
However, this function actually has a void return type and
raises an error if the check fails.

Author: Rintaro Ikeda
Reviewed-by: Jelte Fennema-Nio, Fujii Masao
Discussion: https://postgr.es/m/6a1ca81b27fec4da0ccdfaaaec787982@oss.nttdata.com
This commit is contained in:
Fujii Masao 2024-07-09 21:03:56 +09:00
parent ca481d3c9a
commit 629520be5f

View File

@ -305,12 +305,12 @@ bad_connection:
}
/*
* Validate connection info string, and determine whether it might cause
* local filesystem access to be attempted.
* Validate connection info string.
*
* If the connection string can't be parsed, this function will raise
* an error and will not return. If it can, it will return true if this
* connection string specifies a password and false otherwise.
* an error. If must_use_password is true, the function raises an error
* if no password is provided in the connection string. In any other case
* it successfully completes.
*/
static void
libpqrcv_check_conninfo(const char *conninfo, bool must_use_password)