help.c 15.5 KB
Newer Older
1 2 3 4 5 6 7 8 9
/*
 * builtin-help.c
 *
 * Builtin help-related commands (help, usage, version)
 */
#include "cache.h"
#include "builtin.h"
#include "exec_cmd.h"
#include "common-cmds.h"
Jeff King's avatar
Jeff King committed
10
#include "parse-options.h"
11 12
#include "run-command.h"

13 14
static struct man_viewer_list {
	struct man_viewer_list *next;
15
	char name[FLEX_ARRAY];
16
} *man_viewer_list;
Jeff King's avatar
Jeff King committed
17

18 19 20 21 22 23
static struct man_viewer_info_list {
	struct man_viewer_info_list *next;
	const char *info;
	char name[FLEX_ARRAY];
} *man_viewer_info_list;

Jeff King's avatar
Jeff King committed
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
enum help_format {
	HELP_FORMAT_MAN,
	HELP_FORMAT_INFO,
	HELP_FORMAT_WEB,
};

static int show_all = 0;
static enum help_format help_format = HELP_FORMAT_MAN;
static struct option builtin_help_options[] = {
	OPT_BOOLEAN('a', "all", &show_all, "print all available commands"),
	OPT_SET_INT('m', "man", &help_format, "show man page", HELP_FORMAT_MAN),
	OPT_SET_INT('w', "web", &help_format, "show manual in web browser",
			HELP_FORMAT_WEB),
	OPT_SET_INT('i', "info", &help_format, "show info page",
			HELP_FORMAT_INFO),
39
	OPT_END(),
Jeff King's avatar
Jeff King committed
40 41 42 43 44 45 46 47
};

static const char * const builtin_help_usage[] = {
	"git-help [--all] [--man|--web|--info] [command]",
	NULL
};

static enum help_format parse_help_format(const char *format)
48
{
Jeff King's avatar
Jeff King committed
49 50 51 52 53 54
	if (!strcmp(format, "man"))
		return HELP_FORMAT_MAN;
	if (!strcmp(format, "info"))
		return HELP_FORMAT_INFO;
	if (!strcmp(format, "web") || !strcmp(format, "html"))
		return HELP_FORMAT_WEB;
55 56 57
	die("unrecognized help format '%s'", format);
}

58 59 60 61 62 63 64 65 66 67 68 69
static const char *get_man_viewer_info(const char *name)
{
	struct man_viewer_info_list *viewer;

	for (viewer = man_viewer_info_list; viewer; viewer = viewer->next)
	{
		if (!strcasecmp(name, viewer->name))
			return viewer->info;
	}
	return NULL;
}

70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
static int check_emacsclient_version(void)
{
	struct strbuf buffer = STRBUF_INIT;
	struct child_process ec_process;
	const char *argv_ec[] = { "emacsclient", "--version", NULL };
	int version;

	/* emacsclient prints its version number on stderr */
	memset(&ec_process, 0, sizeof(ec_process));
	ec_process.argv = argv_ec;
	ec_process.err = -1;
	ec_process.stdout_to_stderr = 1;
	if (start_command(&ec_process)) {
		fprintf(stderr, "Failed to start emacsclient.\n");
		return -1;
	}
	strbuf_read(&buffer, ec_process.err, 20);
	close(ec_process.err);

	/*
	 * Don't bother checking return value, because "emacsclient --version"
	 * seems to always exits with code 1.
	 */
	finish_command(&ec_process);

	if (prefixcmp(buffer.buf, "emacsclient")) {
		fprintf(stderr, "Failed to parse emacsclient version.\n");
		strbuf_release(&buffer);
		return -1;
	}

	strbuf_remove(&buffer, 0, strlen("emacsclient"));
	version = atoi(buffer.buf);

	if (version < 22) {
		fprintf(stderr,
			"emacsclient version '%d' too old (< 22).\n",
			version);
		strbuf_release(&buffer);
		return -1;
	}

	strbuf_release(&buffer);
	return 0;
}

116
static void exec_woman_emacs(const char* path, const char *page)
117 118 119 120
{
	if (!check_emacsclient_version()) {
		/* This works only with emacsclient version >= 22. */
		struct strbuf man_page = STRBUF_INIT;
121 122 123

		if (!path)
			path = "emacsclient";
124
		strbuf_addf(&man_page, "(woman \"%s\")", page);
125 126
		execlp(path, "emacsclient", "-e", man_page.buf, NULL);
		warning("failed to exec '%s': %s", path, strerror(errno));
127 128 129
	}
}

130
static void exec_man_konqueror(const char* path, const char *page)
131 132 133 134
{
	const char *display = getenv("DISPLAY");
	if (display && *display) {
		struct strbuf man_page = STRBUF_INIT;
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
		const char *filename = "kfmclient";

		/* It's simpler to launch konqueror using kfmclient. */
		if (path) {
			const char *file = strrchr(path, '/');
			if (file && !strcmp(file + 1, "konqueror")) {
				char *new = xstrdup(path);
				char *dest = strrchr(new, '/');

				/* strlen("konqueror") == strlen("kfmclient") */
				strcpy(dest + 1, "kfmclient");
				path = new;
			}
			if (file)
				filename = file;
		} else
			path = "kfmclient";
152
		strbuf_addf(&man_page, "man:%s(1)", page);
153 154
		execlp(path, filename, "newTab", man_page.buf, NULL);
		warning("failed to exec '%s': %s", path, strerror(errno));
155 156 157
	}
}

158
static void exec_man_man(const char* path, const char *page)
159
{
160 161 162 163
	if (!path)
		path = "man";
	execlp(path, "man", page, NULL);
	warning("failed to exec '%s': %s", path, strerror(errno));
164 165
}

166 167 168 169 170 171 172 173 174
static void exec_man_cmd(const char *cmd, const char *page)
{
	struct strbuf shell_cmd = STRBUF_INIT;
	strbuf_addf(&shell_cmd, "%s %s", cmd, page);
	execl("/bin/sh", "sh", "-c", shell_cmd.buf, NULL);
	warning("failed to exec '%s': %s", cmd, strerror(errno));
}

static void add_man_viewer(const char *name)
175 176
{
	struct man_viewer_list **p = &man_viewer_list;
177
	size_t len = strlen(name);
178 179 180

	while (*p)
		p = &((*p)->next);
181 182 183 184 185 186 187 188 189
	*p = xcalloc(1, (sizeof(**p) + len + 1));
	strncpy((*p)->name, name, len);
}

static int supported_man_viewer(const char *name, size_t len)
{
	return (!strncasecmp("man", name, len) ||
		!strncasecmp("woman", name, len) ||
		!strncasecmp("konqueror", name, len));
190 191
}

192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
static void do_add_man_viewer_info(const char *name,
				   size_t len,
				   const char *value)
{
	struct man_viewer_info_list *new = xcalloc(1, sizeof(*new) + len + 1);

	strncpy(new->name, name, len);
	new->info = xstrdup(value);
	new->next = man_viewer_info_list;
	man_viewer_info_list = new;
}

static int add_man_viewer_path(const char *name,
			       size_t len,
			       const char *value)
{
	if (supported_man_viewer(name, len))
		do_add_man_viewer_info(name, len, value);
	else
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
		warning("'%s': path for unsupported man viewer.\n"
			"Please consider using 'man.<tool>.cmd' instead.",
			name);

	return 0;
}

static int add_man_viewer_cmd(const char *name,
			      size_t len,
			      const char *value)
{
	if (supported_man_viewer(name, len))
		warning("'%s': cmd for supported man viewer.\n"
			"Please consider using 'man.<tool>.path' instead.",
			name);
	else
		do_add_man_viewer_info(name, len, value);
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244

	return 0;
}

static int add_man_viewer_info(const char *var, const char *value)
{
	const char *name = var + 4;
	const char *subkey = strrchr(name, '.');

	if (!subkey)
		return error("Config with no key for man viewer: %s", name);

	if (!strcmp(subkey, ".path")) {
		if (!value)
			return config_error_nonbool(var);
		return add_man_viewer_path(name, subkey - name, value);
	}
245 246 247 248 249
	if (!strcmp(subkey, ".cmd")) {
		if (!value)
			return config_error_nonbool(var);
		return add_man_viewer_cmd(name, subkey - name, value);
	}
250 251 252 253 254

	warning("'%s': unsupported man viewer sub key.", subkey);
	return 0;
}

255
static int git_help_config(const char *var, const char *value, void *cb)
256
{
Jeff King's avatar
Jeff King committed
257 258 259 260 261 262
	if (!strcmp(var, "help.format")) {
		if (!value)
			return config_error_nonbool(var);
		help_format = parse_help_format(value);
		return 0;
	}
263 264 265
	if (!strcmp(var, "man.viewer")) {
		if (!value)
			return config_error_nonbool(var);
266 267
		add_man_viewer(value);
		return 0;
268
	}
269 270 271
	if (!prefixcmp(var, "man."))
		return add_man_viewer_info(var, value);

272
	return git_default_config(var, value, cb);
273 274
}

275
/* most GUI terminals set COLUMNS (although some don't export it) */
276 277 278
static int term_columns(void)
{
	char *col_string = getenv("COLUMNS");
279
	int n_cols;
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302

	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);
}

303 304 305 306 307 308 309 310 311 312
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)
313
{
314 315
	struct cmdname *ent = xmalloc(sizeof(*ent) + len);

316 317 318
	ent->len = len;
	memcpy(ent->name, name, len);
	ent->name[len] = 0;
319 320 321

	ALLOC_GROW(cmds->names, cmds->cnt + 1, cmds->alloc);
	cmds->names[cmds->cnt++] = ent;
322 323 324 325 326 327 328 329 330
}

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);
}

331 332 333 334 335 336 337 338 339 340 341 342 343 344
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;
}

345 346
static void exclude_cmds(struct cmdnames *cmds, struct cmdnames *excludes)
{
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
	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)
368 369 370 371 372 373 374 375
{
	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;
376
	rows = (cmds->cnt + cols - 1) / cols;
377 378 379 380 381 382 383

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

		for (j = 0; j < cols; j++) {
			int n = j * rows + i;
			int size = space;
384
			if (n >= cmds->cnt)
385
				break;
386
			if (j == cols-1 || n + rows >= cmds->cnt)
387
				size = 1;
388
			printf("%-*s", size, cmds->names[n]->name);
389 390 391 392 393
		}
		putchar('\n');
	}
}

394 395
static unsigned int list_commands_in_dir(struct cmdnames *cmds,
					 const char *path)
396 397
{
	unsigned int longest = 0;
398 399
	const char *prefix = "git-";
	int prefix_len = strlen(prefix);
400
	DIR *dir = opendir(path);
401 402
	struct dirent *de;

403 404
	if (!dir || chdir(path))
		return 0;
405 406 407 408 409

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

410
		if (prefixcmp(de->d_name, prefix))
411
			continue;
412 413

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

418
		entlen = strlen(de->d_name) - prefix_len;
419
		if (has_extension(de->d_name, ".exe"))
420 421 422 423 424
			entlen -= 4;

		if (longest < entlen)
			longest = entlen;

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

429 430 431
	return longest;
}

Jeff King's avatar
Jeff King committed
432
static unsigned int load_command_list(void)
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
{
	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);

Jeff King's avatar
Jeff King committed
472 473 474 475 476 477 478 479
	return longest;
}

static void list_commands(void)
{
	unsigned int longest = load_command_list();
	const char *exec_path = git_exec_path();

480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
	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');
	}
495 496
}

497
void list_common_cmds_help(void)
498 499 500 501 502 503 504 505 506 507
{
	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++) {
508 509
		printf("   %s   ", common_cmds[i].name);
		mput_char(' ', longest - strlen(common_cmds[i].name));
510 511 512 513
		puts(common_cmds[i].help);
	}
}

Jeff King's avatar
Jeff King committed
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
static int is_in_cmdlist(struct cmdnames *c, const char *s)
{
	int i;
	for (i = 0; i < c->cnt; i++)
		if (!strcmp(s, c->names[i]->name))
			return 1;
	return 0;
}

static int is_git_command(const char *s)
{
	load_command_list();
	return is_in_cmdlist(&main_cmds, s) ||
		is_in_cmdlist(&other_cmds, s);
}

530
static const char *cmd_to_page(const char *git_cmd)
531
{
532 533 534
	if (!git_cmd)
		return "git";
	else if (!prefixcmp(git_cmd, "git"))
535
		return git_cmd;
536 537
	else {
		int page_len = strlen(git_cmd) + 4;
538
		char *p = xmalloc(page_len + 1);
539 540 541
		strcpy(p, "git-");
		strcpy(p + 4, git_cmd);
		p[page_len] = 0;
542
		return p;
543
	}
544
}
545

546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
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);
}

567 568
static void exec_viewer(const char *name, const char *page)
{
569
	const char *info = get_man_viewer_info(name);
570 571

	if (!strcasecmp(name, "man"))
572
		exec_man_man(info, page);
573
	else if (!strcasecmp(name, "woman"))
574
		exec_woman_emacs(info, page);
575
	else if (!strcasecmp(name, "konqueror"))
576 577 578
		exec_man_konqueror(info, page);
	else if (info)
		exec_man_cmd(info, page);
579
	else
580
		warning("'%s': unknown man viewer.", name);
581 582
}

583 584
static void show_man_page(const char *git_cmd)
{
585
	struct man_viewer_list *viewer;
586
	const char *page = cmd_to_page(git_cmd);
587

588
	setup_man_path();
589 590
	for (viewer = man_viewer_list; viewer; viewer = viewer->next)
	{
591
		exec_viewer(viewer->name, page); /* will return when unable */
592
	}
593
	exec_viewer("man", page);
594
	die("no man viewer handled the request");
595 596
}

597 598 599
static void show_info_page(const char *git_cmd)
{
	const char *page = cmd_to_page(git_cmd);
600
	setenv("INFOPATH", GIT_INFO_PATH, 1);
601
	execlp("info", "info", "gitman", page, NULL);
602 603
}

604 605 606 607 608 609 610 611 612 613 614 615
static void get_html_page_path(struct strbuf *page_path, const char *page)
{
	struct stat st;

	/* Check that we have a git documentation directory. */
	if (stat(GIT_HTML_PATH "/git.html", &st) || !S_ISREG(st.st_mode))
		die("'%s': not a documentation directory.", GIT_HTML_PATH);

	strbuf_init(page_path, 0);
	strbuf_addf(page_path, GIT_HTML_PATH "/%s.html", page);
}

616 617 618
static void show_html_page(const char *git_cmd)
{
	const char *page = cmd_to_page(git_cmd);
619 620 621 622
	struct strbuf page_path; /* it leaks but we exec bellow */

	get_html_page_path(&page_path, page);

623
	execl_git_cmd("web--browse", "-c", "help.browser", page_path.buf, NULL);
624 625
}

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

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

638
int cmd_help(int argc, const char **argv, const char *prefix)
639
{
Jeff King's avatar
Jeff King committed
640
	int nongit;
Jeff King's avatar
Jeff King committed
641
	const char *alias;
642

Jeff King's avatar
Jeff King committed
643
	setup_git_directory_gently(&nongit);
644
	git_config(git_help_config, NULL);
645

Jeff King's avatar
Jeff King committed
646 647 648 649
	argc = parse_options(argc, argv, builtin_help_options,
			builtin_help_usage, 0);

	if (show_all) {
650
		printf("usage: %s\n\n", git_usage_string);
651
		list_commands();
652
		printf("%s\n", git_more_info_string);
Jeff King's avatar
Jeff King committed
653
		return 0;
654
	}
655

Jeff King's avatar
Jeff King committed
656 657 658
	if (!argv[0]) {
		printf("usage: %s\n\n", git_usage_string);
		list_common_cmds_help();
659
		printf("\n%s\n", git_more_info_string);
Jeff King's avatar
Jeff King committed
660
		return 0;
661 662
	}

Jeff King's avatar
Jeff King committed
663 664 665 666 667 668
	alias = alias_lookup(argv[0]);
	if (alias && !is_git_command(argv[0])) {
		printf("`git %s' is aliased to `%s'\n", argv[0], alias);
		return 0;
	}

Jeff King's avatar
Jeff King committed
669 670 671 672 673 674 675 676 677 678
	switch (help_format) {
	case HELP_FORMAT_MAN:
		show_man_page(argv[0]);
		break;
	case HELP_FORMAT_INFO:
		show_info_page(argv[0]);
		break;
	case HELP_FORMAT_WEB:
		show_html_page(argv[0]);
		break;
679
	}
680

681 682
	return 0;
}