help.c 8.81 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 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
#include "parse-options.h"

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

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)
35
{
Jeff King's avatar
Jeff King committed
36 37 38 39 40 41
	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;
42 43 44 45 46
	die("unrecognized help format '%s'", format);
}

static int git_help_config(const char *var, const char *value)
{
Jeff King's avatar
Jeff King committed
47 48 49 50 51 52
	if (!strcmp(var, "help.format")) {
		if (!value)
			return config_error_nonbool(var);
		help_format = parse_help_format(value);
		return 0;
	}
53 54 55
	return git_default_config(var, value);
}

56
/* most GUI terminals set COLUMNS (although some don't export it) */
57 58 59
static int term_columns(void)
{
	char *col_string = getenv("COLUMNS");
60
	int n_cols;
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83

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

84 85 86 87 88 89 90 91 92 93
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)
94
{
95 96
	struct cmdname *ent = xmalloc(sizeof(*ent) + len);

97 98 99
	ent->len = len;
	memcpy(ent->name, name, len);
	ent->name[len] = 0;
100 101 102

	ALLOC_GROW(cmds->names, cmds->cnt + 1, cmds->alloc);
	cmds->names[cmds->cnt++] = ent;
103 104 105 106 107 108 109 110 111
}

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

112 113 114 115 116 117 118 119 120 121 122 123 124 125
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;
}

126 127
static void exclude_cmds(struct cmdnames *cmds, struct cmdnames *excludes)
{
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
	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)
149 150 151 152 153 154 155 156
{
	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;
157
	rows = (cmds->cnt + cols - 1) / cols;
158 159 160 161 162 163 164

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

		for (j = 0; j < cols; j++) {
			int n = j * rows + i;
			int size = space;
165
			if (n >= cmds->cnt)
166
				break;
167
			if (j == cols-1 || n + rows >= cmds->cnt)
168
				size = 1;
169
			printf("%-*s", size, cmds->names[n]->name);
170 171 172 173 174
		}
		putchar('\n');
	}
}

175 176
static unsigned int list_commands_in_dir(struct cmdnames *cmds,
					 const char *path)
177 178
{
	unsigned int longest = 0;
179 180
	const char *prefix = "git-";
	int prefix_len = strlen(prefix);
181
	DIR *dir = opendir(path);
182 183
	struct dirent *de;

184 185
	if (!dir || chdir(path))
		return 0;
186 187 188 189 190

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

191
		if (prefixcmp(de->d_name, prefix))
192
			continue;
193 194

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

199
		entlen = strlen(de->d_name) - prefix_len;
200
		if (has_extension(de->d_name, ".exe"))
201 202 203 204 205
			entlen -= 4;

		if (longest < entlen)
			longest = entlen;

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

210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
	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');
	}
268 269
}

270
void list_common_cmds_help(void)
271 272 273 274 275 276 277 278 279 280
{
	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++) {
281 282
		printf("   %s   ", common_cmds[i].name);
		mput_char(' ', longest - strlen(common_cmds[i].name));
283 284 285 286
		puts(common_cmds[i].help);
	}
}

287
static const char *cmd_to_page(const char *git_cmd)
288
{
289 290 291
	if (!git_cmd)
		return "git";
	else if (!prefixcmp(git_cmd, "git"))
292
		return git_cmd;
293 294
	else {
		int page_len = strlen(git_cmd) + 4;
295
		char *p = xmalloc(page_len + 1);
296 297 298
		strcpy(p, "git-");
		strcpy(p + 4, git_cmd);
		p[page_len] = 0;
299
		return p;
300
	}
301
}
302

303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
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);
}

324 325 326
static void show_man_page(const char *git_cmd)
{
	const char *page = cmd_to_page(git_cmd);
327
	setup_man_path();
328 329 330
	execlp("man", "man", page, NULL);
}

331 332 333
static void show_info_page(const char *git_cmd)
{
	const char *page = cmd_to_page(git_cmd);
334
	setenv("INFOPATH", GIT_INFO_PATH, 1);
335
	execlp("info", "info", "gitman", page, NULL);
336 337
}

338 339 340 341 342 343 344 345 346 347 348 349
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);
}

350 351 352
static void show_html_page(const char *git_cmd)
{
	const char *page = cmd_to_page(git_cmd);
353 354 355 356
	struct strbuf page_path; /* it leaks but we exec bellow */

	get_html_page_path(&page_path, page);

357
	execl_git_cmd("web--browse", "-c", "help.browser", page_path.buf, NULL);
358 359
}

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

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

372
int cmd_help(int argc, const char **argv, const char *prefix)
373
{
Jeff King's avatar
Jeff King committed
374
	int nongit;
375

Jeff King's avatar
Jeff King committed
376 377
	setup_git_directory_gently(&nongit);
	git_config(git_help_config);
378

Jeff King's avatar
Jeff King committed
379 380 381 382
	argc = parse_options(argc, argv, builtin_help_options,
			builtin_help_usage, 0);

	if (show_all) {
383
		printf("usage: %s\n\n", git_usage_string);
384
		list_commands();
Jeff King's avatar
Jeff King committed
385
		return 0;
386
	}
387

Jeff King's avatar
Jeff King committed
388 389 390 391
	if (!argv[0]) {
		printf("usage: %s\n\n", git_usage_string);
		list_common_cmds_help();
		return 0;
392 393
	}

Jeff King's avatar
Jeff King committed
394 395 396 397 398 399 400 401 402 403
	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;
404
	}
405

406 407
	return 0;
}