git: support --list-cmds=list-<category>
[git/git.git] / help.h
CommitLineData
940208a7
MV
1#ifndef HELP_H
2#define HELP_H
3
6bb2dc0b
NTND
4struct string_list;
5
940208a7
MV
6struct cmdnames {
7 int alloc;
8 int cnt;
9 struct cmdname {
8af84dad 10 size_t len; /* also used for similarity index in help.c */
940208a7
MV
11 char name[FLEX_ARRAY];
12 } **names;
13};
14
3d78d1f1
MV
15static inline void mput_char(char c, unsigned int num)
16{
17 while(num--)
18 putchar(c);
19}
20
fd5c363d 21extern void list_common_cmds_help(void);
6bb2dc0b
NTND
22extern void list_all_main_cmds(struct string_list *list);
23extern void list_all_other_cmds(struct string_list *list);
3c777767
NTND
24extern void list_cmds_by_category(struct string_list *list,
25 const char *category);
fd5c363d
TF
26extern const char *help_unknown_cmd(const char *cmd);
27extern void load_command_list(const char *prefix,
28 struct cmdnames *main_cmds,
29 struct cmdnames *other_cmds);
30extern void add_cmdname(struct cmdnames *cmds, const char *name, int len);
940208a7 31/* Here we require that excludes is a sorted list. */
fd5c363d
TF
32extern void exclude_cmds(struct cmdnames *cmds, struct cmdnames *excludes);
33extern int is_in_cmdlist(struct cmdnames *cmds, const char *name);
f4ed0af6 34extern void list_commands(unsigned int colopts, struct cmdnames *main_cmds, struct cmdnames *other_cmds);
940208a7 35
e5618106
VV
36/*
37 * call this to die(), when it is suspected that the user mistyped a
38 * ref to the command, to give suggested "correct" refs.
39 */
40extern void help_unknown_ref(const char *ref, const char *cmd, const char *error);
940208a7 41#endif /* HELP_H */