mirror of
https://github.com/git/git.git
synced 2024-05-06 06:26:12 +02:00
1b81d8cb19
The help command currently hard codes the list of guides and their summary in C. Let's move this list to command-list.txt. This lets us extract summary lines from Documentation/git*.txt. This also potentially lets us list guides in git.txt, but I'll leave that for now. Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
45 lines
1.4 KiB
C
45 lines
1.4 KiB
C
#ifndef HELP_H
|
|
#define HELP_H
|
|
|
|
struct string_list;
|
|
|
|
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 void list_all_cmds_help(void);
|
|
extern void list_common_guides_help(void);
|
|
|
|
extern void list_all_main_cmds(struct string_list *list);
|
|
extern void list_all_other_cmds(struct string_list *list);
|
|
extern void list_cmds_by_category(struct string_list *list,
|
|
const char *category);
|
|
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 */
|