blob: 2d5107142926d46230d17715211338c1aa171e69 [file] [log] [blame]
Miklos Vajna3d78d1f2008-08-02 10:08:38 +02001/*
Miklos Vajna3d78d1f2008-08-02 10:08:38 +02002 * Builtin help command
3 */
4#include "cache.h"
Brandon Williamsb2141fc2017-06-14 11:07:36 -07005#include "config.h"
Miklos Vajna3d78d1f2008-08-02 10:08:38 +02006#include "builtin.h"
Stefan Bellerd807c4a2018-04-10 14:26:18 -07007#include "exec-cmd.h"
Miklos Vajna3d78d1f2008-08-02 10:08:38 +02008#include "parse-options.h"
9#include "run-command.h"
Nguyễn Thái Ngọc Duydbfae682012-04-13 17:54:37 +070010#include "column.h"
Miklos Vajna3d78d1f2008-08-02 10:08:38 +020011#include "help.h"
12
Vincent van Ravesteijn1cc8af02012-06-06 20:28:16 +000013#ifndef DEFAULT_HELP_FORMAT
14#define DEFAULT_HELP_FORMAT "man"
15#endif
16
Miklos Vajna3d78d1f2008-08-02 10:08:38 +020017static struct man_viewer_list {
18 struct man_viewer_list *next;
19 char name[FLEX_ARRAY];
20} *man_viewer_list;
21
22static struct man_viewer_info_list {
23 struct man_viewer_info_list *next;
24 const char *info;
25 char name[FLEX_ARRAY];
26} *man_viewer_info_list;
27
28enum help_format {
Christian Couder3caa8232010-01-09 06:10:05 +010029 HELP_FORMAT_NONE,
Miklos Vajna3d78d1f2008-08-02 10:08:38 +020030 HELP_FORMAT_MAN,
31 HELP_FORMAT_INFO,
Gary V. Vaughan4b055482010-05-14 09:31:35 +000032 HELP_FORMAT_WEB
Miklos Vajna3d78d1f2008-08-02 10:08:38 +020033};
34
Chris Webb89a852e2012-06-28 07:58:02 +010035static const char *html_path;
36
Miklos Vajna3d78d1f2008-08-02 10:08:38 +020037static int show_all = 0;
Philip Oakley65f98352013-04-02 23:39:50 +010038static int show_guides = 0;
Nguyễn Thái Ngọc Duydbfae682012-04-13 17:54:37 +070039static unsigned int colopts;
Christian Couder3caa8232010-01-09 06:10:05 +010040static enum help_format help_format = HELP_FORMAT_NONE;
Ralf Thielowaf741282016-08-26 19:58:35 +020041static int exclude_guides;
Miklos Vajna3d78d1f2008-08-02 10:08:38 +020042static struct option builtin_help_options[] = {
Philip Oakley15f7d492013-04-02 23:39:49 +010043 OPT_BOOL('a', "all", &show_all, N_("print all available commands")),
Ralf Thielowaf741282016-08-26 19:58:35 +020044 OPT_HIDDEN_BOOL(0, "exclude-guides", &exclude_guides, N_("exclude guides")),
Philip Oakley65f98352013-04-02 23:39:50 +010045 OPT_BOOL('g', "guides", &show_guides, N_("print list of useful guides")),
Nguyễn Thái Ngọc Duy68918692012-08-20 19:32:17 +070046 OPT_SET_INT('m', "man", &help_format, N_("show man page"), HELP_FORMAT_MAN),
47 OPT_SET_INT('w', "web", &help_format, N_("show manual in web browser"),
Miklos Vajna3d78d1f2008-08-02 10:08:38 +020048 HELP_FORMAT_WEB),
Nguyễn Thái Ngọc Duy68918692012-08-20 19:32:17 +070049 OPT_SET_INT('i', "info", &help_format, N_("show info page"),
Miklos Vajna3d78d1f2008-08-02 10:08:38 +020050 HELP_FORMAT_INFO),
51 OPT_END(),
52};
53
54static const char * const builtin_help_usage[] = {
Alex Henrie9c9b4f22015-01-13 00:44:47 -070055 N_("git help [--all] [--guides] [--man | --web | --info] [<command>]"),
Miklos Vajna3d78d1f2008-08-02 10:08:38 +020056 NULL
57};
58
59static enum help_format parse_help_format(const char *format)
60{
61 if (!strcmp(format, "man"))
62 return HELP_FORMAT_MAN;
63 if (!strcmp(format, "info"))
64 return HELP_FORMAT_INFO;
65 if (!strcmp(format, "web") || !strcmp(format, "html"))
66 return HELP_FORMAT_WEB;
Nguyễn Thái Ngọc Duy96656272012-04-23 19:30:24 +070067 die(_("unrecognized help format '%s'"), format);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +020068}
69
70static const char *get_man_viewer_info(const char *name)
71{
72 struct man_viewer_info_list *viewer;
73
74 for (viewer = man_viewer_info_list; viewer; viewer = viewer->next)
75 {
76 if (!strcasecmp(name, viewer->name))
77 return viewer->info;
78 }
79 return NULL;
80}
81
82static int check_emacsclient_version(void)
83{
84 struct strbuf buffer = STRBUF_INIT;
René Scharfed3180272014-08-19 21:09:35 +020085 struct child_process ec_process = CHILD_PROCESS_INIT;
Miklos Vajna3d78d1f2008-08-02 10:08:38 +020086 const char *argv_ec[] = { "emacsclient", "--version", NULL };
87 int version;
88
89 /* emacsclient prints its version number on stderr */
Miklos Vajna3d78d1f2008-08-02 10:08:38 +020090 ec_process.argv = argv_ec;
91 ec_process.err = -1;
92 ec_process.stdout_to_stderr = 1;
Johannes Sixt4e2715f2009-06-08 22:34:31 +020093 if (start_command(&ec_process))
Nguyễn Thái Ngọc Duy96656272012-04-23 19:30:24 +070094 return error(_("Failed to start emacsclient."));
Johannes Sixt4e2715f2009-06-08 22:34:31 +020095
Miklos Vajna3d78d1f2008-08-02 10:08:38 +020096 strbuf_read(&buffer, ec_process.err, 20);
97 close(ec_process.err);
98
99 /*
100 * Don't bother checking return value, because "emacsclient --version"
101 * seems to always exits with code 1.
102 */
103 finish_command(&ec_process);
104
Christian Couder59556542013-11-30 21:55:40 +0100105 if (!starts_with(buffer.buf, "emacsclient")) {
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200106 strbuf_release(&buffer);
Nguyễn Thái Ngọc Duy96656272012-04-23 19:30:24 +0700107 return error(_("Failed to parse emacsclient version."));
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200108 }
109
110 strbuf_remove(&buffer, 0, strlen("emacsclient"));
111 version = atoi(buffer.buf);
112
113 if (version < 22) {
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200114 strbuf_release(&buffer);
Nguyễn Thái Ngọc Duy96656272012-04-23 19:30:24 +0700115 return error(_("emacsclient version '%d' too old (< 22)."),
Johannes Sixt4e2715f2009-06-08 22:34:31 +0200116 version);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200117 }
118
119 strbuf_release(&buffer);
120 return 0;
121}
122
Felipe Contreras4b25d092009-05-01 12:06:36 +0300123static void exec_woman_emacs(const char *path, const char *page)
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200124{
125 if (!check_emacsclient_version()) {
126 /* This works only with emacsclient version >= 22. */
127 struct strbuf man_page = STRBUF_INIT;
128
129 if (!path)
130 path = "emacsclient";
131 strbuf_addf(&man_page, "(woman \"%s\")", page);
Thomas Rast5d314752010-07-24 17:20:23 +0200132 execlp(path, "emacsclient", "-e", man_page.buf, (char *)NULL);
Nguyễn Thái Ngọc Duy57477492016-05-08 16:47:27 +0700133 warning_errno(_("failed to exec '%s'"), path);
Rene Scharfebad0e2c2017-08-30 19:49:46 +0200134 strbuf_release(&man_page);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200135 }
136}
137
Felipe Contreras4b25d092009-05-01 12:06:36 +0300138static void exec_man_konqueror(const char *path, const char *page)
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200139{
140 const char *display = getenv("DISPLAY");
141 if (display && *display) {
142 struct strbuf man_page = STRBUF_INIT;
143 const char *filename = "kfmclient";
144
145 /* It's simpler to launch konqueror using kfmclient. */
146 if (path) {
Jeff King4c9ac3b2015-09-24 17:08:16 -0400147 size_t len;
148 if (strip_suffix(path, "/konqueror", &len))
149 path = xstrfmt("%.*s/kfmclient", (int)len, path);
150 filename = basename((char *)path);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200151 } else
152 path = "kfmclient";
153 strbuf_addf(&man_page, "man:%s(1)", page);
Thomas Rast5d314752010-07-24 17:20:23 +0200154 execlp(path, filename, "newTab", man_page.buf, (char *)NULL);
Nguyễn Thái Ngọc Duy57477492016-05-08 16:47:27 +0700155 warning_errno(_("failed to exec '%s'"), path);
Rene Scharfea981a9f2017-08-30 19:49:44 +0200156 strbuf_release(&man_page);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200157 }
158}
159
Felipe Contreras4b25d092009-05-01 12:06:36 +0300160static void exec_man_man(const char *path, const char *page)
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200161{
162 if (!path)
163 path = "man";
Thomas Rast5d314752010-07-24 17:20:23 +0200164 execlp(path, "man", page, (char *)NULL);
Nguyễn Thái Ngọc Duy57477492016-05-08 16:47:27 +0700165 warning_errno(_("failed to exec '%s'"), path);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200166}
167
168static void exec_man_cmd(const char *cmd, const char *page)
169{
170 struct strbuf shell_cmd = STRBUF_INIT;
171 strbuf_addf(&shell_cmd, "%s %s", cmd, page);
Kyle J. McKayb680a862015-03-07 21:08:00 -0800172 execl(SHELL_PATH, SHELL_PATH, "-c", shell_cmd.buf, (char *)NULL);
Nguyễn Thái Ngọc Duy57477492016-05-08 16:47:27 +0700173 warning(_("failed to exec '%s'"), cmd);
Rene Scharfe72462182017-08-30 19:49:45 +0200174 strbuf_release(&shell_cmd);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200175}
176
177static void add_man_viewer(const char *name)
178{
179 struct man_viewer_list **p = &man_viewer_list;
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200180
181 while (*p)
182 p = &((*p)->next);
Jeff King96ffc062016-02-22 17:44:32 -0500183 FLEX_ALLOC_STR(*p, name, name);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200184}
185
186static int supported_man_viewer(const char *name, size_t len)
187{
188 return (!strncasecmp("man", name, len) ||
189 !strncasecmp("woman", name, len) ||
190 !strncasecmp("konqueror", name, len));
191}
192
193static void do_add_man_viewer_info(const char *name,
194 size_t len,
195 const char *value)
196{
Brandon Williams8adda462018-02-14 10:59:32 -0800197 struct man_viewer_info_list *new_man_viewer;
198 FLEX_ALLOC_MEM(new_man_viewer, name, name, len);
199 new_man_viewer->info = xstrdup(value);
200 new_man_viewer->next = man_viewer_info_list;
201 man_viewer_info_list = new_man_viewer;
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200202}
203
204static int add_man_viewer_path(const char *name,
205 size_t len,
206 const char *value)
207{
208 if (supported_man_viewer(name, len))
209 do_add_man_viewer_info(name, len, value);
210 else
Nguyễn Thái Ngọc Duy96656272012-04-23 19:30:24 +0700211 warning(_("'%s': path for unsupported man viewer.\n"
212 "Please consider using 'man.<tool>.cmd' instead."),
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200213 name);
214
215 return 0;
216}
217
218static int add_man_viewer_cmd(const char *name,
219 size_t len,
220 const char *value)
221{
222 if (supported_man_viewer(name, len))
Nguyễn Thái Ngọc Duy96656272012-04-23 19:30:24 +0700223 warning(_("'%s': cmd for supported man viewer.\n"
224 "Please consider using 'man.<tool>.path' instead."),
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200225 name);
226 else
227 do_add_man_viewer_info(name, len, value);
228
229 return 0;
230}
231
232static int add_man_viewer_info(const char *var, const char *value)
233{
Jeff King4d5c6ce2013-01-23 01:27:09 -0500234 const char *name, *subkey;
235 int namelen;
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200236
Jeff King4d5c6ce2013-01-23 01:27:09 -0500237 if (parse_config_key(var, "man", &name, &namelen, &subkey) < 0 || !name)
Johannes Sixt178b5132009-04-23 15:49:06 +0200238 return 0;
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200239
Jeff King4d5c6ce2013-01-23 01:27:09 -0500240 if (!strcmp(subkey, "path")) {
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200241 if (!value)
242 return config_error_nonbool(var);
Jeff King4d5c6ce2013-01-23 01:27:09 -0500243 return add_man_viewer_path(name, namelen, value);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200244 }
Jeff King4d5c6ce2013-01-23 01:27:09 -0500245 if (!strcmp(subkey, "cmd")) {
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200246 if (!value)
247 return config_error_nonbool(var);
Jeff King4d5c6ce2013-01-23 01:27:09 -0500248 return add_man_viewer_cmd(name, namelen, value);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200249 }
250
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200251 return 0;
252}
253
254static int git_help_config(const char *var, const char *value, void *cb)
255{
Christian Couder59556542013-11-30 21:55:40 +0100256 if (starts_with(var, "column."))
Nguyễn Thái Ngọc Duydbfae682012-04-13 17:54:37 +0700257 return git_column_config(var, value, "help", &colopts);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200258 if (!strcmp(var, "help.format")) {
259 if (!value)
260 return config_error_nonbool(var);
261 help_format = parse_help_format(value);
262 return 0;
263 }
Chris Webb89a852e2012-06-28 07:58:02 +0100264 if (!strcmp(var, "help.htmlpath")) {
265 if (!value)
266 return config_error_nonbool(var);
267 html_path = xstrdup(value);
268 return 0;
269 }
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200270 if (!strcmp(var, "man.viewer")) {
271 if (!value)
272 return config_error_nonbool(var);
273 add_man_viewer(value);
274 return 0;
275 }
Christian Couder59556542013-11-30 21:55:40 +0100276 if (starts_with(var, "man."))
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200277 return add_man_viewer_info(var, value);
278
279 return git_default_config(var, value, cb);
280}
281
Alex Riesenc7371e92008-08-28 19:17:46 +0200282static struct cmdnames main_cmds, other_cmds;
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200283
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200284static int is_git_command(const char *s)
285{
Sebastian Schuberthc6127fa2014-01-02 17:17:11 +0100286 if (is_builtin(s))
287 return 1;
288
Sebastian Schubertha3c52632014-01-02 17:16:30 +0100289 load_command_list("git-", &main_cmds, &other_cmds);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200290 return is_in_cmdlist(&main_cmds, s) ||
291 is_in_cmdlist(&other_cmds, s);
292}
293
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200294static const char *cmd_to_page(const char *git_cmd)
295{
296 if (!git_cmd)
297 return "git";
Christian Couder59556542013-11-30 21:55:40 +0100298 else if (starts_with(git_cmd, "git"))
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200299 return git_cmd;
300 else if (is_git_command(git_cmd))
Jeff Kingacd47ee2015-09-24 17:07:14 -0400301 return xstrfmt("git-%s", git_cmd);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200302 else
Jeff Kingacd47ee2015-09-24 17:07:14 -0400303 return xstrfmt("git%s", git_cmd);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200304}
305
306static void setup_man_path(void)
307{
Brandon Caseyf285a2d2008-10-09 14:12:12 -0500308 struct strbuf new_path = STRBUF_INIT;
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200309 const char *old_path = getenv("MANPATH");
Junio C Hamano59362e52014-11-24 11:33:54 -0800310 char *git_man_path = system_path(GIT_MAN_PATH);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200311
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200312 /* We should always put ':' after our path. If there is no
313 * old_path, the ':' at the end will let 'man' to try
314 * system-wide paths after ours to find the manual page. If
315 * there is old_path, we need ':' as delimiter. */
Junio C Hamano59362e52014-11-24 11:33:54 -0800316 strbuf_addstr(&new_path, git_man_path);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200317 strbuf_addch(&new_path, ':');
318 if (old_path)
319 strbuf_addstr(&new_path, old_path);
320
Junio C Hamano59362e52014-11-24 11:33:54 -0800321 free(git_man_path);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200322 setenv("MANPATH", new_path.buf, 1);
323
324 strbuf_release(&new_path);
325}
326
327static void exec_viewer(const char *name, const char *page)
328{
329 const char *info = get_man_viewer_info(name);
330
331 if (!strcasecmp(name, "man"))
332 exec_man_man(info, page);
333 else if (!strcasecmp(name, "woman"))
334 exec_woman_emacs(info, page);
335 else if (!strcasecmp(name, "konqueror"))
336 exec_man_konqueror(info, page);
337 else if (info)
338 exec_man_cmd(info, page);
339 else
Nguyễn Thái Ngọc Duy96656272012-04-23 19:30:24 +0700340 warning(_("'%s': unknown man viewer."), name);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200341}
342
343static void show_man_page(const char *git_cmd)
344{
345 struct man_viewer_list *viewer;
346 const char *page = cmd_to_page(git_cmd);
Romain Francoise5059a422008-08-29 17:00:43 +0200347 const char *fallback = getenv("GIT_MAN_VIEWER");
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200348
349 setup_man_path();
350 for (viewer = man_viewer_list; viewer; viewer = viewer->next)
351 {
352 exec_viewer(viewer->name, page); /* will return when unable */
353 }
Romain Francoise5059a422008-08-29 17:00:43 +0200354 if (fallback)
355 exec_viewer(fallback, page);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200356 exec_viewer("man", page);
Nguyễn Thái Ngọc Duy96656272012-04-23 19:30:24 +0700357 die(_("no man viewer handled the request"));
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200358}
359
360static void show_info_page(const char *git_cmd)
361{
362 const char *page = cmd_to_page(git_cmd);
Steffen Prohaska026fa0d2009-01-18 13:00:09 +0100363 setenv("INFOPATH", system_path(GIT_INFO_PATH), 1);
Thomas Rast5d314752010-07-24 17:20:23 +0200364 execlp("info", "info", "gitman", page, (char *)NULL);
Nguyễn Thái Ngọc Duy96656272012-04-23 19:30:24 +0700365 die(_("no info viewer handled the request"));
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200366}
367
368static void get_html_page_path(struct strbuf *page_path, const char *page)
369{
370 struct stat st;
Junio C Hamano59362e52014-11-24 11:33:54 -0800371 char *to_free = NULL;
372
Chris Webb89a852e2012-06-28 07:58:02 +0100373 if (!html_path)
Junio C Hamano59362e52014-11-24 11:33:54 -0800374 html_path = to_free = system_path(GIT_HTML_PATH);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200375
376 /* Check that we have a git documentation directory. */
Chris Webb86272b42012-06-28 07:58:03 +0100377 if (!strstr(html_path, "://")) {
378 if (stat(mkpath("%s/git.html", html_path), &st)
379 || !S_ISREG(st.st_mode))
380 die("'%s': not a documentation directory.", html_path);
381 }
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200382
383 strbuf_init(page_path, 0);
384 strbuf_addf(page_path, "%s/%s.html", html_path, page);
Junio C Hamano59362e52014-11-24 11:33:54 -0800385 free(to_free);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200386}
387
Linus Torvalds2af202b2009-06-18 10:28:43 -0700388static void open_html(const char *path)
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200389{
Thomas Rast5d314752010-07-24 17:20:23 +0200390 execl_git_cmd("web--browse", "-c", "help.browser", path, (char *)NULL);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200391}
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200392
393static void show_html_page(const char *git_cmd)
394{
395 const char *page = cmd_to_page(git_cmd);
396 struct strbuf page_path; /* it leaks but we exec bellow */
397
398 get_html_page_path(&page_path, page);
399
400 open_html(page_path.buf);
401}
402
Philip Oakley002b7262013-04-02 23:39:51 +0100403static struct {
404 const char *name;
405 const char *help;
406} common_guides[] = {
Simon Ruderich3561e602013-04-12 15:51:42 +0200407 { "attributes", N_("Defining attributes per path") },
Philip Oakley673151a2014-10-10 22:25:37 +0100408 { "everyday", N_("Everyday Git With 20 Commands Or So") },
Simon Ruderich3561e602013-04-12 15:51:42 +0200409 { "glossary", N_("A Git glossary") },
410 { "ignore", N_("Specifies intentionally untracked files to ignore") },
411 { "modules", N_("Defining submodule properties") },
412 { "revisions", N_("Specifying revisions and ranges for Git") },
413 { "tutorial", N_("A tutorial introduction to Git (for version 1.5.1 or newer)") },
414 { "workflows", N_("An overview of recommended workflows with Git") },
Philip Oakley002b7262013-04-02 23:39:51 +0100415};
416
417static void list_common_guides_help(void)
418{
419 int i, longest = 0;
420
421 for (i = 0; i < ARRAY_SIZE(common_guides); i++) {
422 if (longest < strlen(common_guides[i].name))
423 longest = strlen(common_guides[i].name);
424 }
425
426 puts(_("The common Git guides are:\n"));
427 for (i = 0; i < ARRAY_SIZE(common_guides); i++) {
428 printf(" %s ", common_guides[i].name);
429 mput_char(' ', longest - strlen(common_guides[i].name));
430 puts(_(common_guides[i].help));
431 }
432 putchar('\n');
433}
434
Ralf Thielowaf741282016-08-26 19:58:35 +0200435static const char *check_git_cmd(const char* cmd)
436{
437 char *alias;
438
439 if (is_git_command(cmd))
440 return cmd;
441
442 alias = alias_lookup(cmd);
443 if (alias) {
Kaartic Sivaraamb3a80762017-09-12 16:44:06 +0530444 printf_ln(_("'%s' is aliased to '%s'"), cmd, alias);
Ralf Thielowaf741282016-08-26 19:58:35 +0200445 free(alias);
446 exit(0);
447 }
448
449 if (exclude_guides)
450 return help_unknown_cmd(cmd);
451
452 return cmd;
453}
454
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200455int cmd_help(int argc, const char **argv, const char *prefix)
456{
457 int nongit;
Christian Couder3caa8232010-01-09 06:10:05 +0100458 enum help_format parsed_help_format;
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200459
Stephen Boyd37782922009-05-23 11:53:12 -0700460 argc = parse_options(argc, argv, prefix, builtin_help_options,
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200461 builtin_help_usage, 0);
Christian Couder3caa8232010-01-09 06:10:05 +0100462 parsed_help_format = help_format;
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200463
464 if (show_all) {
Nguyễn Thái Ngọc Duydbfae682012-04-13 17:54:37 +0700465 git_config(git_help_config, NULL);
Nguyễn Thái Ngọc Duy96656272012-04-23 19:30:24 +0700466 printf(_("usage: %s%s"), _(git_usage_string), "\n\n");
Sebastian Schubertha3c52632014-01-02 17:16:30 +0100467 load_command_list("git-", &main_cmds, &other_cmds);
Junio C Hamanof4ed0af2012-05-03 15:13:31 -0700468 list_commands(colopts, &main_cmds, &other_cmds);
Philip Oakley15f7d492013-04-02 23:39:49 +0100469 }
470
Philip Oakley002b7262013-04-02 23:39:51 +0100471 if (show_guides)
472 list_common_guides_help();
Philip Oakley65f98352013-04-02 23:39:50 +0100473
474 if (show_all || show_guides) {
Nguyễn Thái Ngọc Duy96656272012-04-23 19:30:24 +0700475 printf("%s\n", _(git_more_info_string));
Philip Oakley15f7d492013-04-02 23:39:49 +0100476 /*
477 * We're done. Ignore any remaining args
478 */
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200479 return 0;
480 }
481
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200482 if (!argv[0]) {
Nguyễn Thái Ngọc Duy96656272012-04-23 19:30:24 +0700483 printf(_("usage: %s%s"), _(git_usage_string), "\n\n");
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200484 list_common_cmds_help();
Nguyễn Thái Ngọc Duy96656272012-04-23 19:30:24 +0700485 printf("\n%s\n", _(git_more_info_string));
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200486 return 0;
487 }
488
David Aguilaraf6fbf92009-12-01 11:27:34 -0800489 setup_git_directory_gently(&nongit);
490 git_config(git_help_config, NULL);
491
Pat Thoytsd0408c02012-06-22 13:48:46 +0100492 if (parsed_help_format != HELP_FORMAT_NONE)
Christian Couder3caa8232010-01-09 06:10:05 +0100493 help_format = parsed_help_format;
Pat Thoytsd0408c02012-06-22 13:48:46 +0100494 if (help_format == HELP_FORMAT_NONE)
495 help_format = parse_help_format(DEFAULT_HELP_FORMAT);
Christian Couder3caa8232010-01-09 06:10:05 +0100496
Ralf Thielowaf741282016-08-26 19:58:35 +0200497 argv[0] = check_git_cmd(argv[0]);
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200498
499 switch (help_format) {
Christian Couder3caa8232010-01-09 06:10:05 +0100500 case HELP_FORMAT_NONE:
Miklos Vajna3d78d1f2008-08-02 10:08:38 +0200501 case HELP_FORMAT_MAN:
502 show_man_page(argv[0]);
503 break;
504 case HELP_FORMAT_INFO:
505 show_info_page(argv[0]);
506 break;
507 case HELP_FORMAT_WEB:
508 show_html_page(argv[0]);
509 break;
510 }
511
512 return 0;
513}