summaryrefslogtreecommitdiff
path: root/help.h
diff options
context:
space:
mode:
authorVikrant Varma <vikrant.varma94@gmail.com>2013-05-04 05:34:19 +0530
committerJunio C Hamano <gitster@pobox.com>2013-05-08 15:31:54 -0700
commite56181060e1117d458b854c34e63206117dab8b6 (patch)
tree8251763d9b8200bf2232d8d611af2da31f3e12f0 /help.h
parent9b795193a6a7e963db62d9cd8e86752a40940520 (diff)
downloadgit-e56181060e1117d458b854c34e63206117dab8b6.tar.gz
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 <vikrant.varma94@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'help.h')
-rw-r--r--help.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/help.h b/help.h
index 0ae5a124a3..b21d7c94e8 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 */