[thirdparty/git.git] / help.c

/*
 * builtin-help.c
 *
 * Builtin help-related commands (help, usage, version)
 */
#include "cache.h"
#include "builtin.h"
#include "exec_cmd.h"
#include "common-cmds.h"

/* most GUI terminals set COLUMNS (although some don't export it) */
static int term_columns(void)
{
	char *col_string = getenv("COLUMNS");
	int n_cols;

	if (col_string && (n_cols = atoi(col_string)) > 0)
		return n_cols;

#ifdef TIOCGWINSZ
	{
		struct winsize ws;
		if (!ioctl(1, TIOCGWINSZ, &ws)) {
			if (ws.ws_col)
				return ws.ws_col;
		}
	}
#endif

	return 80;
}

static inline void mput_char(char c, unsigned int num)
{
	while(num--)
		putchar(c);
}

static struct cmdnames {
	int alloc;
	int cnt;
	struct cmdname {
		size_t len;
		char name[1];
	} **names;
} main_cmds, other_cmds;

static void add_cmdname(struct cmdnames *cmds, const char *name, int len)
{
	struct cmdname *ent = xmalloc(sizeof(*ent) + len);

	ent->len = len;
	memcpy(ent->name, name, len);
	ent->name[len] = 0;

	ALLOC_GROW(cmds->names, cmds->cnt + 1, cmds->alloc);
	cmds->names[cmds->cnt++] = ent;
}

static int cmdname_compare(const void *a_, const void *b_)
{
	struct cmdname *a = *(struct cmdname **)a_;
	struct cmdname *b = *(struct cmdname **)b_;
	return strcmp(a->name, b->name);
}

static void uniq(struct cmdnames *cmds)
{
	int i, j;

	if (!cmds->cnt)
		return;

	for (i = j = 1; i < cmds->cnt; i++)
		if (strcmp(cmds->names[i]->name, cmds->names[i-1]->name))
			cmds->names[j++] = cmds->names[i];

	cmds->cnt = j;
}

static void exclude_cmds(struct cmdnames *cmds, struct cmdnames *excludes)
{
	int ci, cj, ei;
	int cmp;

	ci = cj = ei = 0;
	while (ci < cmds->cnt && ei < excludes->cnt) {
		cmp = strcmp(cmds->names[ci]->name, excludes->names[ei]->name);
		if (cmp < 0)
			cmds->names[cj++] = cmds->names[ci++];
		else if (cmp == 0)
			ci++, ei++;
		else if (cmp > 0)
			ei++;
	}

	while (ci < cmds->cnt)
		cmds->names[cj++] = cmds->names[ci++];

	cmds->cnt = cj;
}

static void pretty_print_string_list(struct cmdnames *cmds, int longest)
{
	int cols = 1, rows;
	int space = longest + 1; /* min 1 SP between words */
	int max_cols = term_columns() - 1; /* don't print *on* the edge */
	int i, j;

	if (space < max_cols)
		cols = max_cols / space;
	rows = (cmds->cnt + cols - 1) / cols;

	for (i = 0; i < rows; i++) {
		printf("  ");

		for (j = 0; j < cols; j++) {
			int n = j * rows + i;
			int size = space;
			if (n >= cmds->cnt)
				break;
			if (j == cols-1 || n + rows >= cmds->cnt)
				size = 1;
			printf("%-*s", size, cmds->names[n]->name);
		}
		putchar('\n');
	}
}

static unsigned int list_commands_in_dir(struct cmdnames *cmds,
					 const char *path)
{
	unsigned int longest = 0;
	const char *prefix = "git-";
	int prefix_len = strlen(prefix);
	DIR *dir = opendir(path);
	struct dirent *de;

	if (!dir || chdir(path))
		return 0;

	while ((de = readdir(dir)) != NULL) {
		struct stat st;
		int entlen;

		if (prefixcmp(de->d_name, prefix))
			continue;

		if (stat(de->d_name, &st) || /* stat, not lstat */
		    !S_ISREG(st.st_mode) ||
		    !(st.st_mode & S_IXUSR))
			continue;

		entlen = strlen(de->d_name) - prefix_len;
		if (has_extension(de->d_name, ".exe"))
			entlen -= 4;

		if (longest < entlen)
			longest = entlen;

		add_cmdname(cmds, de->d_name + prefix_len, entlen);
	}
	closedir(dir);

	return longest;
}

static void list_commands(void)
{
	unsigned int longest = 0;
	unsigned int len;
	const char *env_path = getenv("PATH");
	char *paths, *path, *colon;
	const char *exec_path = git_exec_path();

	if (exec_path)
		longest = list_commands_in_dir(&main_cmds, exec_path);

	if (!env_path) {
		fprintf(stderr, "PATH not set\n");
		exit(1);
	}

	path = paths = xstrdup(env_path);
	while (1) {
		if ((colon = strchr(path, ':')))
			*colon = 0;

		len = list_commands_in_dir(&other_cmds, path);
		if (len > longest)
			longest = len;

		if (!colon)
			break;
		path = colon + 1;
	}
	free(paths);

	qsort(main_cmds.names, main_cmds.cnt,
	      sizeof(*main_cmds.names), cmdname_compare);
	uniq(&main_cmds);

	qsort(other_cmds.names, other_cmds.cnt,
	      sizeof(*other_cmds.names), cmdname_compare);
	uniq(&other_cmds);
	exclude_cmds(&other_cmds, &main_cmds);

	if (main_cmds.cnt) {
		printf("available git commands in '%s'\n", exec_path);
		printf("----------------------------");
		mput_char('-', strlen(exec_path));
		putchar('\n');
		pretty_print_string_list(&main_cmds, longest);
		putchar('\n');
	}

	if (other_cmds.cnt) {
		printf("git commands available from elsewhere on your $PATH\n");
		printf("---------------------------------------------------\n");
		pretty_print_string_list(&other_cmds, longest);
		putchar('\n');
	}
}

void list_common_cmds_help(void)
{
	int i, longest = 0;

	for (i = 0; i < ARRAY_SIZE(common_cmds); i++) {
		if (longest < strlen(common_cmds[i].name))
			longest = strlen(common_cmds[i].name);
	}

	puts("The most commonly used git commands are:");
	for (i = 0; i < ARRAY_SIZE(common_cmds); i++) {
		printf("   %s   ", common_cmds[i].name);
		mput_char(' ', longest - strlen(common_cmds[i].name));
		puts(common_cmds[i].help);
	}
}

static const char *cmd_to_page(const char *git_cmd)
{
	if (!git_cmd)
		return "git";
	else if (!prefixcmp(git_cmd, "git"))
		return git_cmd;
	else {
		int page_len = strlen(git_cmd) + 4;
		char *p = xmalloc(page_len + 1);
		strcpy(p, "git-");
		strcpy(p + 4, git_cmd);
		p[page_len] = 0;
		return p;
	}
}

static void setup_man_path(void)
{
	struct strbuf new_path;
	const char *old_path = getenv("MANPATH");

	strbuf_init(&new_path, 0);

	/* We should always put ':' after our path. If there is no
	 * old_path, the ':' at the end will let 'man' to try
	 * system-wide paths after ours to find the manual page. If
	 * there is old_path, we need ':' as delimiter. */
	strbuf_addstr(&new_path, GIT_MAN_PATH);
	strbuf_addch(&new_path, ':');
	if (old_path)
		strbuf_addstr(&new_path, old_path);

	setenv("MANPATH", new_path.buf, 1);

	strbuf_release(&new_path);
}

static void show_man_page(const char *git_cmd)
{
	const char *page = cmd_to_page(git_cmd);
	setup_man_path();
	execlp("man", "man", page, NULL);
}

static void show_info_page(const char *git_cmd)
{
	const char *page = cmd_to_page(git_cmd);
	execlp("info", "info", "gitman", page, NULL);
}

static void show_html_page(const char *git_cmd)
{
	const char *page = cmd_to_page(git_cmd);
	execl_git_cmd("browse-help", page, NULL);
}

void help_unknown_cmd(const char *cmd)
{
	fprintf(stderr, "git: '%s' is not a git-command. See 'git --help'.\n", cmd);
	exit(1);
}

int cmd_version(int argc, const char **argv, const char *prefix)
{
	printf("git version %s\n", git_version_string);
	return 0;
}

int cmd_help(int argc, const char **argv, const char *prefix)
{
	const char *help_cmd = argv[1];

	if (argc < 2) {
		printf("usage: %s\n\n", git_usage_string);
		list_common_cmds_help();
		exit(0);
	}

	if (!strcmp(help_cmd, "--all") || !strcmp(help_cmd, "-a")) {
		printf("usage: %s\n\n", git_usage_string);
		list_commands();
	}

	else if (!strcmp(help_cmd, "--web") || !strcmp(help_cmd, "-w")) {
		show_html_page(argc > 2 ? argv[2] : NULL);
	}

	else if (!strcmp(help_cmd, "--info") || !strcmp(help_cmd, "-i")) {
		show_info_page(argc > 2 ? argv[2] : NULL);
	}

	else
		show_man_page(help_cmd);

	return 0;
}
Commit	Line	Data
70827b15 LT	1	/*
	2	* builtin-help.c
	3	*
	4	* Builtin help-related commands (help, usage, version)
	5	*/
	6	#include "cache.h"
	7	#include "builtin.h"
	8	#include "exec_cmd.h"
	9	#include "common-cmds.h"
70827b15	10
82e5a82f	11	/* most GUI terminals set COLUMNS (although some don't export it) */
70827b15 LT	12	static int term_columns(void)
	13	{
	14	char *col_string = getenv("COLUMNS");
96f1e58f	15	int n_cols;
70827b15 LT	16
	17	if (col_string && (n_cols = atoi(col_string)) > 0)
	18	return n_cols;
	19
	20	#ifdef TIOCGWINSZ
	21	{
	22	struct winsize ws;
	23	if (!ioctl(1, TIOCGWINSZ, &ws)) {
	24	if (ws.ws_col)
	25	return ws.ws_col;
	26	}
	27	}
	28	#endif
	29
	30	return 80;
	31	}
	32
70827b15 LT	33	static inline void mput_char(char c, unsigned int num)
	34	{
	35	while(num--)
	36	putchar(c);
	37	}
	38
1eb05690 SP	39	static struct cmdnames {
	40	int alloc;
	41	int cnt;
	42	struct cmdname {
	43	size_t len;
	44	char name[1];
	45	} **names;
	46	} main_cmds, other_cmds;
	47
	48	static void add_cmdname(struct cmdnames cmds, const char name, int len)
70827b15	49	{
1eb05690 SP	50	struct cmdname ent = xmalloc(sizeof(ent) + len);
1eb05690 SP	51
70827b15 LT	52	ent->len = len;
	53	memcpy(ent->name, name, len);
	54	ent->name[len] = 0;
1eb05690 SP	55
	56	ALLOC_GROW(cmds->names, cmds->cnt + 1, cmds->alloc);
	57	cmds->names[cmds->cnt++] = ent;
70827b15 LT	58	}
	59
	60	static int cmdname_compare(const void a_, const void b_)
	61	{
	62	struct cmdname a = (struct cmdname **)a_;
	63	struct cmdname b = (struct cmdname **)b_;
	64	return strcmp(a->name, b->name);
	65	}
	66
1eb05690 SP	67	static void uniq(struct cmdnames *cmds)
	68	{
	69	int i, j;
	70
	71	if (!cmds->cnt)
	72	return;
	73
	74	for (i = j = 1; i < cmds->cnt; i++)
	75	if (strcmp(cmds->names[i]->name, cmds->names[i-1]->name))
	76	cmds->names[j++] = cmds->names[i];
	77
	78	cmds->cnt = j;
	79	}
	80
f3fa1838 JH	81	static void exclude_cmds(struct cmdnames cmds, struct cmdnames excludes)
f3fa1838 JH	82	{
1eb05690 SP	83	int ci, cj, ei;
	84	int cmp;
	85
	86	ci = cj = ei = 0;
	87	while (ci < cmds->cnt && ei < excludes->cnt) {
	88	cmp = strcmp(cmds->names[ci]->name, excludes->names[ei]->name);
	89	if (cmp < 0)
	90	cmds->names[cj++] = cmds->names[ci++];
	91	else if (cmp == 0)
	92	ci++, ei++;
	93	else if (cmp > 0)
	94	ei++;
	95	}
	96
	97	while (ci < cmds->cnt)
	98	cmds->names[cj++] = cmds->names[ci++];
	99
	100	cmds->cnt = cj;
	101	}
	102
	103	static void pretty_print_string_list(struct cmdnames *cmds, int longest)
70827b15 LT	104	{
	105	int cols = 1, rows;
	106	int space = longest + 1; /* min 1 SP between words */
	107	int max_cols = term_columns() - 1; /* don't print on the edge */
	108	int i, j;
	109
	110	if (space < max_cols)
	111	cols = max_cols / space;
1eb05690	112	rows = (cmds->cnt + cols - 1) / cols;
70827b15 LT	113
	114	for (i = 0; i < rows; i++) {
	115	printf(" ");
	116
	117	for (j = 0; j < cols; j++) {
	118	int n = j * rows + i;
	119	int size = space;
1eb05690	120	if (n >= cmds->cnt)
70827b15	121	break;
1eb05690	122	if (j == cols-1 \|\| n + rows >= cmds->cnt)
70827b15	123	size = 1;
1eb05690	124	printf("%-*s", size, cmds->names[n]->name);
70827b15 LT	125	}
	126	putchar('\n');
	127	}
	128	}
	129
1eb05690 SP	130	static unsigned int list_commands_in_dir(struct cmdnames *cmds,
1eb05690 SP	131	const char *path)
70827b15 LT	132	{
70827b15 LT	133	unsigned int longest = 0;
edb6ddc5 SP	134	const char *prefix = "git-";
edb6ddc5 SP	135	int prefix_len = strlen(prefix);
1eb05690	136	DIR *dir = opendir(path);
70827b15 LT	137	struct dirent *de;
70827b15 LT	138
1eb05690 SP	139	if (!dir \|\| chdir(path))
1eb05690 SP	140	return 0;
70827b15	141
70827b15 LT	142	while ((de = readdir(dir)) != NULL) {
	143	struct stat st;
	144	int entlen;
	145
edb6ddc5	146	if (prefixcmp(de->d_name, prefix))
70827b15	147	continue;
0966003c SP	148
0966003c SP	149	if (stat(de->d_name, &st) \|\| /* stat, not lstat */
70827b15 LT	150	!S_ISREG(st.st_mode) \|\|
	151	!(st.st_mode & S_IXUSR))
	152	continue;
	153
edb6ddc5	154	entlen = strlen(de->d_name) - prefix_len;
5bb1cda5	155	if (has_extension(de->d_name, ".exe"))
70827b15 LT	156	entlen -= 4;
	157
	158	if (longest < entlen)
	159	longest = entlen;
	160
1eb05690	161	add_cmdname(cmds, de->d_name + prefix_len, entlen);
70827b15 LT	162	}
	163	closedir(dir);
	164
1eb05690 SP	165	return longest;
	166	}
	167
	168	static void list_commands(void)
	169	{
	170	unsigned int longest = 0;
	171	unsigned int len;
	172	const char *env_path = getenv("PATH");
	173	char paths, path, *colon;
	174	const char *exec_path = git_exec_path();
	175
	176	if (exec_path)
	177	longest = list_commands_in_dir(&main_cmds, exec_path);
	178
	179	if (!env_path) {
	180	fprintf(stderr, "PATH not set\n");
	181	exit(1);
	182	}
	183
	184	path = paths = xstrdup(env_path);
	185	while (1) {
	186	if ((colon = strchr(path, ':')))
	187	*colon = 0;
	188
	189	len = list_commands_in_dir(&other_cmds, path);
	190	if (len > longest)
	191	longest = len;
	192
	193	if (!colon)
	194	break;
	195	path = colon + 1;
	196	}
	197	free(paths);
	198
	199	qsort(main_cmds.names, main_cmds.cnt,
	200	sizeof(*main_cmds.names), cmdname_compare);
	201	uniq(&main_cmds);
	202
	203	qsort(other_cmds.names, other_cmds.cnt,
	204	sizeof(*other_cmds.names), cmdname_compare);
	205	uniq(&other_cmds);
	206	exclude_cmds(&other_cmds, &main_cmds);
	207
	208	if (main_cmds.cnt) {
	209	printf("available git commands in '%s'\n", exec_path);
	210	printf("----------------------------");
	211	mput_char('-', strlen(exec_path));
	212	putchar('\n');
	213	pretty_print_string_list(&main_cmds, longest);
	214	putchar('\n');
	215	}
	216
	217	if (other_cmds.cnt) {
	218	printf("git commands available from elsewhere on your $PATH\n");
	219	printf("---------------------------------------------------\n");
	220	pretty_print_string_list(&other_cmds, longest);
	221	putchar('\n');
	222	}
70827b15 LT	223	}
70827b15 LT	224
3d7e2d85	225	void list_common_cmds_help(void)
70827b15 LT	226	{
	227	int i, longest = 0;
	228
	229	for (i = 0; i < ARRAY_SIZE(common_cmds); i++) {
	230	if (longest < strlen(common_cmds[i].name))
	231	longest = strlen(common_cmds[i].name);
	232	}
	233
	234	puts("The most commonly used git commands are:");
	235	for (i = 0; i < ARRAY_SIZE(common_cmds); i++) {
4f75b115 RS	236	printf(" %s ", common_cmds[i].name);
4f75b115 RS	237	mput_char(' ', longest - strlen(common_cmds[i].name));
70827b15 LT	238	puts(common_cmds[i].help);
70827b15 LT	239	}
70827b15 LT	240	}
70827b15 LT	241
df55c9cb	242	static const char cmd_to_page(const char git_cmd)
70827b15	243	{
5d6491c7 CC	244	if (!git_cmd)
	245	return "git";
	246	else if (!prefixcmp(git_cmd, "git"))
df55c9cb	247	return git_cmd;
70827b15 LT	248	else {
70827b15 LT	249	int page_len = strlen(git_cmd) + 4;
2d7320d0	250	char *p = xmalloc(page_len + 1);
70827b15 LT	251	strcpy(p, "git-");
	252	strcpy(p + 4, git_cmd);
	253	p[page_len] = 0;
df55c9cb	254	return p;
70827b15	255	}
df55c9cb	256	}
70827b15	257
8e566f24 SO	258	static void setup_man_path(void)
	259	{
	260	struct strbuf new_path;
	261	const char *old_path = getenv("MANPATH");
	262
	263	strbuf_init(&new_path, 0);
	264
	265	/* We should always put ':' after our path. If there is no
	266	* old_path, the ':' at the end will let 'man' to try
	267	* system-wide paths after ours to find the manual page. If
	268	* there is old_path, we need ':' as delimiter. */
	269	strbuf_addstr(&new_path, GIT_MAN_PATH);
	270	strbuf_addch(&new_path, ':');
	271	if (old_path)
	272	strbuf_addstr(&new_path, old_path);
	273
	274	setenv("MANPATH", new_path.buf, 1);
	275
	276	strbuf_release(&new_path);
	277	}
	278
df55c9cb CC	279	static void show_man_page(const char *git_cmd)
	280	{
	281	const char *page = cmd_to_page(git_cmd);
8e566f24	282	setup_man_path();
70827b15 LT	283	execlp("man", "man", page, NULL);
	284	}
	285
df55c9cb CC	286	static void show_info_page(const char *git_cmd)
	287	{
	288	const char *page = cmd_to_page(git_cmd);
78d39f98	289	execlp("info", "info", "gitman", page, NULL);
df55c9cb CC	290	}
df55c9cb CC	291
5d6491c7 CC	292	static void show_html_page(const char *git_cmd)
	293	{
	294	const char *page = cmd_to_page(git_cmd);
	295	execl_git_cmd("browse-help", page, NULL);
	296	}
	297
822a7d50 RJ	298	void help_unknown_cmd(const char *cmd)
822a7d50 RJ	299	{
a238917b	300	fprintf(stderr, "git: '%s' is not a git-command. See 'git --help'.\n", cmd);
822a7d50 RJ	301	exit(1);
	302	}
	303
a633fca0	304	int cmd_version(int argc, const char *argv, const char prefix)
70827b15 LT	305	{
	306	printf("git version %s\n", git_version_string);
	307	return 0;
	308	}
	309
5d6491c7	310	int cmd_help(int argc, const char *argv, const char prefix)
70827b15	311	{
5d6491c7 CC	312	const char *help_cmd = argv[1];
	313
	314	if (argc < 2) {
822a7d50 RJ	315	printf("usage: %s\n\n", git_usage_string);
822a7d50 RJ	316	list_common_cmds_help();
3d7e2d85	317	exit(0);
822a7d50 RJ	318	}
822a7d50 RJ	319
5d6491c7	320	if (!strcmp(help_cmd, "--all") \|\| !strcmp(help_cmd, "-a")) {
822a7d50	321	printf("usage: %s\n\n", git_usage_string);
1eb05690	322	list_commands();
822a7d50	323	}
df55c9cb	324
5d6491c7 CC	325	else if (!strcmp(help_cmd, "--web") \|\| !strcmp(help_cmd, "-w")) {
	326	show_html_page(argc > 2 ? argv[2] : NULL);
	327	}
df55c9cb	328
5d6491c7 CC	329	else if (!strcmp(help_cmd, "--info") \|\| !strcmp(help_cmd, "-i")) {
5d6491c7 CC	330	show_info_page(argc > 2 ? argv[2] : NULL);
df55c9cb	331	}
822a7d50	332
70827b15 LT	333	else
70827b15 LT	334	show_man_page(help_cmd);
822a7d50	335
70827b15 LT	336	return 0;
70827b15 LT	337	}