mirror of
https://github.com/git/git.git
synced 2024-11-14 13:13:01 +01:00
e56181060e
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>
35 lines
1.1 KiB
C
35 lines
1.1 KiB
C
#ifndef HELP_H
|
|
#define HELP_H
|
|
|
|
struct cmdnames {
|
|
int alloc;
|
|
int cnt;
|
|
struct cmdname {
|
|
size_t len; /* also used for similarity index in help.c */
|
|
char name[FLEX_ARRAY];
|
|
} **names;
|
|
};
|
|
|
|
static inline void mput_char(char c, unsigned int num)
|
|
{
|
|
while(num--)
|
|
putchar(c);
|
|
}
|
|
|
|
extern void list_common_cmds_help(void);
|
|
extern const char *help_unknown_cmd(const char *cmd);
|
|
extern void load_command_list(const char *prefix,
|
|
struct cmdnames *main_cmds,
|
|
struct cmdnames *other_cmds);
|
|
extern void add_cmdname(struct cmdnames *cmds, const char *name, int len);
|
|
/* Here we require that excludes is a sorted list. */
|
|
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 */
|