From: Firmin Martin Date: Thu, 13 May 2021 21:41:51 GMT Subject: [PATCH 1/2] prompt.h: clarify the non-use of git_prompt Message-ID: <20210513214152.34792-2-firminmartin24@gmail.com> In-Reply-To: <20210513214152.34792-1-firminmartin24@gmail.com> It's really tempting to use git_prompt to prompt user for input, but in most of the case, we must not [1]. Reflect this as a comment in prompt.h. [1]: https://lore.kernel.org/git/YJTH+sTP%2FO5Nxtp9@coredump.intra.peff.net/ Reported-by: Jeff King Signed-off-by: Firmin Martin --- prompt.h | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/prompt.h b/prompt.h index e294e93541..90eb3f08a3 100644 --- a/prompt.h +++ b/prompt.h @@ -4,6 +4,16 @@ #define PROMPT_ASKPASS (1<<0) #define PROMPT_ECHO (1<<1) +/* + * This function should not be used for regular prompts (i.e., asking user for + * confirmation or picking an option from an interactive menu) as it only + * accepts input from /dev/tty, thus making it impossible to test with the + * current test suite. Please instead use git_read_line_interactively for that + * purpose. See 97387c8bdd (am: read interactive input from stdin, 2019-05-20) + * for historical context. + * + */ + char *git_prompt(const char *prompt, int flags); int git_read_line_interactively(struct strbuf *line); -- 2.31.1.443.g67a420f573