From e56181060e1117d458b854c34e63206117dab8b6 Mon Sep 17 00:00:00 2001 From: Vikrant Varma Date: Sat, 4 May 2013 05:34:19 +0530 Subject: help: add help_unknown_ref() When the user gives an unknown string to a command that expects to get a ref, we could be more helpful than just saying "that's not a ref" and die. Add helper function help_unknown_ref() to take care of displaying an error message along with a list of suggested refs the user might have meant. An interaction with "git merge" might go like this: $ git merge foo merge: foo - not something we can merge Did you mean one of these? origin/foo upstream/foo Signed-off-by: Vikrant Varma Signed-off-by: Junio C Hamano --- help.h | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'help.h') diff --git a/help.h b/help.h index 0ae5a124a..b21d7c94e 100644 --- a/help.h +++ b/help.h @@ -27,4 +27,9 @@ extern void exclude_cmds(struct cmdnames *cmds, struct cmdnames *excludes); extern int is_in_cmdlist(struct cmdnames *cmds, const char *name); extern void list_commands(unsigned int colopts, struct cmdnames *main_cmds, struct cmdnames *other_cmds); +/* + * call this to die(), when it is suspected that the user mistyped a + * ref to the command, to give suggested "correct" refs. + */ +extern void help_unknown_ref(const char *ref, const char *cmd, const char *error); #endif /* HELP_H */ -- cgit v1.2.1