From: Richard Levitte Date: Mon, 16 May 2016 13:39:50 +0000 (+0200) Subject: Documentation: Clarify sizes for UI_add_input_string() X-Git-Tag: OpenSSL_1_1_0-pre6~824 X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=727ee8cfeb2893d5aec4a6e571e9adf0667e9135;p=oweals%2Fopenssl.git Documentation: Clarify sizes for UI_add_input_string() The given sizes to not include the final NUL character. RT#2622 Reviewed-by: Matt Caswell --- diff --git a/doc/crypto/ui.pod b/doc/crypto/ui.pod index f03e989561..bd4e396ab9 100644 --- a/doc/crypto/ui.pod +++ b/doc/crypto/ui.pod @@ -110,12 +110,12 @@ If B is NULL nothing is done. UI_add_input_string() and UI_add_verify_string() add a prompt to the UI, as well as flags and a result buffer and the desired minimum and maximum -sizes of the result. The given information is used to prompt for -information, for example a password, and to verify a password (i.e. having -the user enter it twice and check that the same string was entered twice). -UI_add_verify_string() takes and extra argument that should be a pointer -to the result buffer of the input string that it's supposed to verify, or -verification will fail. +sizes of the result, not counting the final NUL character. The given +information is used to prompt for information, for example a password, +and to verify a password (i.e. having the user enter it twice and check +that the same string was entered twice). UI_add_verify_string() takes +and extra argument that should be a pointer to the result buffer of the +input string that it's supposed to verify, or verification will fail. UI_add_input_boolean() adds a prompt to the UI that's supposed to be answered in a boolean way, with a single character for yes and a different character