mirror of
https://github.com/git/git.git
synced 2024-11-24 18:33:43 +08:00
3ac68a93fd
Sometimes it helps to list all available config vars so the user can search for something they want. The config man page can also be used but it's harder to search if you want to focus on the variable name, for example. This is not the best way to collect the available config since it's not precise. Ideally we should have a centralized list of config in C code (pretty much like 'struct option'), but that's a lot more work. This will do for now. Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
89 lines
3.1 KiB
C
89 lines
3.1 KiB
C
#ifndef HELP_H
|
|
#define HELP_H
|
|
|
|
#include "string-list.h"
|
|
#include "strbuf.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 void list_all_cmds_help(void);
|
|
extern void list_common_guides_help(void);
|
|
extern void list_config_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 void list_cmds_by_config(struct string_list *list);
|
|
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);
|
|
|
|
static inline void list_config_item(struct string_list *list,
|
|
const char *prefix,
|
|
const char *str)
|
|
{
|
|
string_list_append_nodup(list, xstrfmt("%s.%s", prefix, str));
|
|
}
|
|
|
|
#define define_list_config_array(array) \
|
|
void list_config_##array(struct string_list *list, const char *prefix) \
|
|
{ \
|
|
int i; \
|
|
for (i = 0; i < ARRAY_SIZE(array); i++) \
|
|
if (array[i]) \
|
|
list_config_item(list, prefix, array[i]); \
|
|
} \
|
|
struct string_list
|
|
|
|
#define define_list_config_array_extra(array, values) \
|
|
void list_config_##array(struct string_list *list, const char *prefix) \
|
|
{ \
|
|
int i; \
|
|
static const char *extra[] = values; \
|
|
for (i = 0; i < ARRAY_SIZE(extra); i++) \
|
|
list_config_item(list, prefix, extra[i]); \
|
|
for (i = 0; i < ARRAY_SIZE(array); i++) \
|
|
if (array[i]) \
|
|
list_config_item(list, prefix, array[i]); \
|
|
} \
|
|
struct string_list
|
|
|
|
/* These are actually scattered over many C files */
|
|
void list_config_advices(struct string_list *list, const char *prefix);
|
|
void list_config_color_branch_slots(struct string_list *list, const char *prefix);
|
|
void list_config_color_decorate_slots(struct string_list *list, const char *prefix);
|
|
void list_config_color_diff_slots(struct string_list *list, const char *prefix);
|
|
void list_config_color_grep_slots(struct string_list *list, const char *prefix);
|
|
void list_config_color_interactive_slots(struct string_list *list, const char *prefix);
|
|
void list_config_color_status_slots(struct string_list *list, const char *prefix);
|
|
void list_config_fsck_msg_ids(struct string_list *list, const char *prefix);
|
|
|
|
#endif /* HELP_H */
|