2008-08-02 08:08:38 +00:00
|
|
|
/*
|
|
|
|
* Builtin help command
|
|
|
|
*/
|
|
|
|
#include "cache.h"
|
2017-06-14 18:07:36 +00:00
|
|
|
#include "config.h"
|
2008-08-02 08:08:38 +00:00
|
|
|
#include "builtin.h"
|
2018-04-10 21:26:18 +00:00
|
|
|
#include "exec-cmd.h"
|
2008-08-02 08:08:38 +00:00
|
|
|
#include "parse-options.h"
|
|
|
|
#include "run-command.h"
|
2012-04-13 10:54:37 +00:00
|
|
|
#include "column.h"
|
help: move list_config_help to builtin/help
Starting in 3ac68a93fd2, help.o began to depend on builtin/branch.o,
builtin/clean.o, and builtin/config.o. This meant that help.o was
unusable outside of the context of the main Git executable.
To make help.o usable by other commands again, move list_config_help()
into builtin/help.c (where it makes sense to assume other builtin libraries
are present).
When command-list.h is included but a member is not used, we start to
hear a compiler warning. Since the config list is generated in a fairly
different way than the command list, and since commands and config
options are semantically different, move the config list into its own
header and move the generator into its own script and build rule.
For reasons explained in 976aaedc (msvc: add a Makefile target to
pre-generate the Visual Studio solution, 2019-07-29), some build
artifacts we consider non-source files cannot be generated in the
Visual Studio environment, and we already have some Makefile tweaks
to help Visual Studio to use generated command-list.h header file.
Do the same to a new generated file, config-list.h, introduced by
this change.
Helped-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
2020-04-16 21:18:03 +00:00
|
|
|
#include "config-list.h"
|
2008-08-02 08:08:38 +00:00
|
|
|
#include "help.h"
|
2018-05-20 18:40:06 +00:00
|
|
|
#include "alias.h"
|
2008-08-02 08:08:38 +00:00
|
|
|
|
2012-06-06 20:28:16 +00:00
|
|
|
#ifndef DEFAULT_HELP_FORMAT
|
|
|
|
#define DEFAULT_HELP_FORMAT "man"
|
|
|
|
#endif
|
|
|
|
|
2008-08-02 08:08:38 +00:00
|
|
|
static struct man_viewer_list {
|
|
|
|
struct man_viewer_list *next;
|
|
|
|
char name[FLEX_ARRAY];
|
|
|
|
} *man_viewer_list;
|
|
|
|
|
|
|
|
static struct man_viewer_info_list {
|
|
|
|
struct man_viewer_info_list *next;
|
|
|
|
const char *info;
|
|
|
|
char name[FLEX_ARRAY];
|
|
|
|
} *man_viewer_info_list;
|
|
|
|
|
|
|
|
enum help_format {
|
2010-01-09 05:10:05 +00:00
|
|
|
HELP_FORMAT_NONE,
|
2008-08-02 08:08:38 +00:00
|
|
|
HELP_FORMAT_MAN,
|
|
|
|
HELP_FORMAT_INFO,
|
2010-05-14 09:31:35 +00:00
|
|
|
HELP_FORMAT_WEB
|
2008-08-02 08:08:38 +00:00
|
|
|
};
|
|
|
|
|
2012-06-28 06:58:02 +00:00
|
|
|
static const char *html_path;
|
|
|
|
|
2008-08-02 08:08:38 +00:00
|
|
|
static int show_all = 0;
|
2013-04-02 22:39:50 +00:00
|
|
|
static int show_guides = 0;
|
2018-05-26 13:55:24 +00:00
|
|
|
static int show_config;
|
2018-09-29 06:08:14 +00:00
|
|
|
static int verbose = 1;
|
2012-04-13 10:54:37 +00:00
|
|
|
static unsigned int colopts;
|
2010-01-09 05:10:05 +00:00
|
|
|
static enum help_format help_format = HELP_FORMAT_NONE;
|
2016-08-26 17:58:35 +00:00
|
|
|
static int exclude_guides;
|
2008-08-02 08:08:38 +00:00
|
|
|
static struct option builtin_help_options[] = {
|
2013-04-02 22:39:49 +00:00
|
|
|
OPT_BOOL('a', "all", &show_all, N_("print all available commands")),
|
2016-08-26 17:58:35 +00:00
|
|
|
OPT_HIDDEN_BOOL(0, "exclude-guides", &exclude_guides, N_("exclude guides")),
|
2013-04-02 22:39:50 +00:00
|
|
|
OPT_BOOL('g', "guides", &show_guides, N_("print list of useful guides")),
|
2018-05-26 13:55:24 +00:00
|
|
|
OPT_BOOL('c', "config", &show_config, N_("print all configuration variable names")),
|
2018-05-26 13:55:28 +00:00
|
|
|
OPT_SET_INT_F(0, "config-for-completion", &show_config, "", 2, PARSE_OPT_HIDDEN),
|
2012-08-20 12:32:17 +00:00
|
|
|
OPT_SET_INT('m', "man", &help_format, N_("show man page"), HELP_FORMAT_MAN),
|
|
|
|
OPT_SET_INT('w', "web", &help_format, N_("show manual in web browser"),
|
2008-08-02 08:08:38 +00:00
|
|
|
HELP_FORMAT_WEB),
|
2012-08-20 12:32:17 +00:00
|
|
|
OPT_SET_INT('i', "info", &help_format, N_("show info page"),
|
2008-08-02 08:08:38 +00:00
|
|
|
HELP_FORMAT_INFO),
|
2018-05-20 18:40:01 +00:00
|
|
|
OPT__VERBOSE(&verbose, N_("print command description")),
|
2008-08-02 08:08:38 +00:00
|
|
|
OPT_END(),
|
|
|
|
};
|
|
|
|
|
|
|
|
static const char * const builtin_help_usage[] = {
|
2021-09-21 22:40:32 +00:00
|
|
|
N_("git help [-a|--all] [--[no-]verbose]]\n"
|
2021-09-10 11:28:42 +00:00
|
|
|
" [[-i|--info] [-m|--man] [-w|--web]] [<command>]"),
|
2021-09-21 22:40:32 +00:00
|
|
|
N_("git help [-g|--guides]"),
|
2021-09-21 22:40:34 +00:00
|
|
|
N_("git help [-c|--config]"),
|
2008-08-02 08:08:38 +00:00
|
|
|
NULL
|
|
|
|
};
|
|
|
|
|
help: move list_config_help to builtin/help
Starting in 3ac68a93fd2, help.o began to depend on builtin/branch.o,
builtin/clean.o, and builtin/config.o. This meant that help.o was
unusable outside of the context of the main Git executable.
To make help.o usable by other commands again, move list_config_help()
into builtin/help.c (where it makes sense to assume other builtin libraries
are present).
When command-list.h is included but a member is not used, we start to
hear a compiler warning. Since the config list is generated in a fairly
different way than the command list, and since commands and config
options are semantically different, move the config list into its own
header and move the generator into its own script and build rule.
For reasons explained in 976aaedc (msvc: add a Makefile target to
pre-generate the Visual Studio solution, 2019-07-29), some build
artifacts we consider non-source files cannot be generated in the
Visual Studio environment, and we already have some Makefile tweaks
to help Visual Studio to use generated command-list.h header file.
Do the same to a new generated file, config-list.h, introduced by
this change.
Helped-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
2020-04-16 21:18:03 +00:00
|
|
|
struct slot_expansion {
|
|
|
|
const char *prefix;
|
|
|
|
const char *placeholder;
|
|
|
|
void (*fn)(struct string_list *list, const char *prefix);
|
|
|
|
int found;
|
|
|
|
};
|
|
|
|
|
|
|
|
static void list_config_help(int for_human)
|
|
|
|
{
|
|
|
|
struct slot_expansion slot_expansions[] = {
|
|
|
|
{ "advice", "*", list_config_advices },
|
|
|
|
{ "color.branch", "<slot>", list_config_color_branch_slots },
|
|
|
|
{ "color.decorate", "<slot>", list_config_color_decorate_slots },
|
|
|
|
{ "color.diff", "<slot>", list_config_color_diff_slots },
|
|
|
|
{ "color.grep", "<slot>", list_config_color_grep_slots },
|
|
|
|
{ "color.interactive", "<slot>", list_config_color_interactive_slots },
|
|
|
|
{ "color.remote", "<slot>", list_config_color_sideband_slots },
|
|
|
|
{ "color.status", "<slot>", list_config_color_status_slots },
|
|
|
|
{ "fsck", "<msg-id>", list_config_fsck_msg_ids },
|
|
|
|
{ "receive.fsck", "<msg-id>", list_config_fsck_msg_ids },
|
|
|
|
{ NULL, NULL, NULL }
|
|
|
|
};
|
|
|
|
const char **p;
|
|
|
|
struct slot_expansion *e;
|
|
|
|
struct string_list keys = STRING_LIST_INIT_DUP;
|
|
|
|
int i;
|
|
|
|
|
|
|
|
for (p = config_name_list; *p; p++) {
|
|
|
|
const char *var = *p;
|
|
|
|
struct strbuf sb = STRBUF_INIT;
|
|
|
|
|
|
|
|
for (e = slot_expansions; e->prefix; e++) {
|
|
|
|
|
|
|
|
strbuf_reset(&sb);
|
|
|
|
strbuf_addf(&sb, "%s.%s", e->prefix, e->placeholder);
|
|
|
|
if (!strcasecmp(var, sb.buf)) {
|
|
|
|
e->fn(&keys, e->prefix);
|
|
|
|
e->found++;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
strbuf_release(&sb);
|
|
|
|
if (!e->prefix)
|
|
|
|
string_list_append(&keys, var);
|
|
|
|
}
|
|
|
|
|
|
|
|
for (e = slot_expansions; e->prefix; e++)
|
|
|
|
if (!e->found)
|
|
|
|
BUG("slot_expansion %s.%s is not used",
|
|
|
|
e->prefix, e->placeholder);
|
|
|
|
|
|
|
|
string_list_sort(&keys);
|
|
|
|
for (i = 0; i < keys.nr; i++) {
|
|
|
|
const char *var = keys.items[i].string;
|
|
|
|
const char *wildcard, *tag, *cut;
|
|
|
|
|
|
|
|
if (for_human) {
|
|
|
|
puts(var);
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
wildcard = strchr(var, '*');
|
|
|
|
tag = strchr(var, '<');
|
|
|
|
|
|
|
|
if (!wildcard && !tag) {
|
|
|
|
puts(var);
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (wildcard && !tag)
|
|
|
|
cut = wildcard;
|
|
|
|
else if (!wildcard && tag)
|
|
|
|
cut = tag;
|
|
|
|
else
|
|
|
|
cut = wildcard < tag ? wildcard : tag;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* We may produce duplicates, but that's up to
|
|
|
|
* git-completion.bash to handle
|
|
|
|
*/
|
|
|
|
printf("%.*s\n", (int)(cut - var), var);
|
|
|
|
}
|
|
|
|
string_list_clear(&keys, 0);
|
|
|
|
}
|
|
|
|
|
2008-08-02 08:08:38 +00:00
|
|
|
static enum help_format parse_help_format(const char *format)
|
|
|
|
{
|
|
|
|
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;
|
2019-02-16 11:24:41 +00:00
|
|
|
/*
|
|
|
|
* Please update _git_config() in git-completion.bash when you
|
|
|
|
* add new help formats.
|
|
|
|
*/
|
2012-04-23 12:30:24 +00:00
|
|
|
die(_("unrecognized help format '%s'"), format);
|
2008-08-02 08:08:38 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
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;
|
|
|
|
}
|
|
|
|
|
|
|
|
static int check_emacsclient_version(void)
|
|
|
|
{
|
|
|
|
struct strbuf buffer = STRBUF_INIT;
|
2014-08-19 19:09:35 +00:00
|
|
|
struct child_process ec_process = CHILD_PROCESS_INIT;
|
2008-08-02 08:08:38 +00:00
|
|
|
const char *argv_ec[] = { "emacsclient", "--version", NULL };
|
|
|
|
int version;
|
|
|
|
|
|
|
|
/* emacsclient prints its version number on stderr */
|
|
|
|
ec_process.argv = argv_ec;
|
|
|
|
ec_process.err = -1;
|
|
|
|
ec_process.stdout_to_stderr = 1;
|
2009-06-08 20:34:31 +00:00
|
|
|
if (start_command(&ec_process))
|
2012-04-23 12:30:24 +00:00
|
|
|
return error(_("Failed to start emacsclient."));
|
2009-06-08 20:34:31 +00:00
|
|
|
|
2008-08-02 08:08:38 +00:00
|
|
|
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);
|
|
|
|
|
2013-11-30 20:55:40 +00:00
|
|
|
if (!starts_with(buffer.buf, "emacsclient")) {
|
2008-08-02 08:08:38 +00:00
|
|
|
strbuf_release(&buffer);
|
2012-04-23 12:30:24 +00:00
|
|
|
return error(_("Failed to parse emacsclient version."));
|
2008-08-02 08:08:38 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
strbuf_remove(&buffer, 0, strlen("emacsclient"));
|
|
|
|
version = atoi(buffer.buf);
|
|
|
|
|
|
|
|
if (version < 22) {
|
|
|
|
strbuf_release(&buffer);
|
2012-04-23 12:30:24 +00:00
|
|
|
return error(_("emacsclient version '%d' too old (< 22)."),
|
2009-06-08 20:34:31 +00:00
|
|
|
version);
|
2008-08-02 08:08:38 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
strbuf_release(&buffer);
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2009-05-01 09:06:36 +00:00
|
|
|
static void exec_woman_emacs(const char *path, const char *page)
|
2008-08-02 08:08:38 +00:00
|
|
|
{
|
|
|
|
if (!check_emacsclient_version()) {
|
|
|
|
/* This works only with emacsclient version >= 22. */
|
|
|
|
struct strbuf man_page = STRBUF_INIT;
|
|
|
|
|
|
|
|
if (!path)
|
|
|
|
path = "emacsclient";
|
|
|
|
strbuf_addf(&man_page, "(woman \"%s\")", page);
|
2010-07-24 15:20:23 +00:00
|
|
|
execlp(path, "emacsclient", "-e", man_page.buf, (char *)NULL);
|
2016-05-08 09:47:27 +00:00
|
|
|
warning_errno(_("failed to exec '%s'"), path);
|
2017-08-30 17:49:46 +00:00
|
|
|
strbuf_release(&man_page);
|
2008-08-02 08:08:38 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2009-05-01 09:06:36 +00:00
|
|
|
static void exec_man_konqueror(const char *path, const char *page)
|
2008-08-02 08:08:38 +00:00
|
|
|
{
|
|
|
|
const char *display = getenv("DISPLAY");
|
|
|
|
if (display && *display) {
|
|
|
|
struct strbuf man_page = STRBUF_INIT;
|
|
|
|
const char *filename = "kfmclient";
|
|
|
|
|
|
|
|
/* It's simpler to launch konqueror using kfmclient. */
|
|
|
|
if (path) {
|
help: clean up kfmclient munging
When we are going to launch "/path/to/konqueror", we instead
rewrite this into "/path/to/kfmclient" by duplicating the
original string and writing over the ending bits. This can
be done more obviously with strip_suffix and xstrfmt.
Note that we also fix a subtle bug with the "filename"
parameter, which is passed as argv[0] to the child. If the
user has configured a program name with no directory
component, we always pass the string "kfmclient", even if
your program is called something else. But if you give a
full path, we give the basename of that path. But more
bizarrely, if we rewrite "konqueror" to "kfmclient", we
still pass "konqueror".
The history of this function doesn't reveal anything
interesting, so it looks like just an oversight from
combining the suffix-munging with the basename-finding.
Let's just call basename on the munged path, which produces
consistent results (if you gave a program, whether a full
path or not, we pass its basename).
Probably this doesn't matter at all in practice, but it
makes the code slightly less confusing to read.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2015-09-24 21:08:16 +00:00
|
|
|
size_t len;
|
|
|
|
if (strip_suffix(path, "/konqueror", &len))
|
|
|
|
path = xstrfmt("%.*s/kfmclient", (int)len, path);
|
|
|
|
filename = basename((char *)path);
|
2008-08-02 08:08:38 +00:00
|
|
|
} else
|
|
|
|
path = "kfmclient";
|
|
|
|
strbuf_addf(&man_page, "man:%s(1)", page);
|
2010-07-24 15:20:23 +00:00
|
|
|
execlp(path, filename, "newTab", man_page.buf, (char *)NULL);
|
2016-05-08 09:47:27 +00:00
|
|
|
warning_errno(_("failed to exec '%s'"), path);
|
2017-08-30 17:49:44 +00:00
|
|
|
strbuf_release(&man_page);
|
2008-08-02 08:08:38 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2009-05-01 09:06:36 +00:00
|
|
|
static void exec_man_man(const char *path, const char *page)
|
2008-08-02 08:08:38 +00:00
|
|
|
{
|
|
|
|
if (!path)
|
|
|
|
path = "man";
|
2010-07-24 15:20:23 +00:00
|
|
|
execlp(path, "man", page, (char *)NULL);
|
2016-05-08 09:47:27 +00:00
|
|
|
warning_errno(_("failed to exec '%s'"), path);
|
2008-08-02 08:08:38 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
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);
|
2015-03-08 05:08:00 +00:00
|
|
|
execl(SHELL_PATH, SHELL_PATH, "-c", shell_cmd.buf, (char *)NULL);
|
2016-05-08 09:47:27 +00:00
|
|
|
warning(_("failed to exec '%s'"), cmd);
|
2017-08-30 17:49:45 +00:00
|
|
|
strbuf_release(&shell_cmd);
|
2008-08-02 08:08:38 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static void add_man_viewer(const char *name)
|
|
|
|
{
|
|
|
|
struct man_viewer_list **p = &man_viewer_list;
|
|
|
|
|
|
|
|
while (*p)
|
|
|
|
p = &((*p)->next);
|
2016-02-22 22:44:32 +00:00
|
|
|
FLEX_ALLOC_STR(*p, name, name);
|
2008-08-02 08:08:38 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static int supported_man_viewer(const char *name, size_t len)
|
|
|
|
{
|
|
|
|
return (!strncasecmp("man", name, len) ||
|
|
|
|
!strncasecmp("woman", name, len) ||
|
|
|
|
!strncasecmp("konqueror", name, len));
|
|
|
|
}
|
|
|
|
|
|
|
|
static void do_add_man_viewer_info(const char *name,
|
|
|
|
size_t len,
|
|
|
|
const char *value)
|
|
|
|
{
|
2018-02-14 18:59:32 +00:00
|
|
|
struct man_viewer_info_list *new_man_viewer;
|
|
|
|
FLEX_ALLOC_MEM(new_man_viewer, name, name, len);
|
|
|
|
new_man_viewer->info = xstrdup(value);
|
|
|
|
new_man_viewer->next = man_viewer_info_list;
|
|
|
|
man_viewer_info_list = new_man_viewer;
|
2008-08-02 08:08:38 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
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
|
2012-04-23 12:30:24 +00:00
|
|
|
warning(_("'%s': path for unsupported man viewer.\n"
|
|
|
|
"Please consider using 'man.<tool>.cmd' instead."),
|
2008-08-02 08:08:38 +00:00
|
|
|
name);
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
static int add_man_viewer_cmd(const char *name,
|
|
|
|
size_t len,
|
|
|
|
const char *value)
|
|
|
|
{
|
|
|
|
if (supported_man_viewer(name, len))
|
2012-04-23 12:30:24 +00:00
|
|
|
warning(_("'%s': cmd for supported man viewer.\n"
|
|
|
|
"Please consider using 'man.<tool>.path' instead."),
|
2008-08-02 08:08:38 +00:00
|
|
|
name);
|
|
|
|
else
|
|
|
|
do_add_man_viewer_info(name, len, value);
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
static int add_man_viewer_info(const char *var, const char *value)
|
|
|
|
{
|
2013-01-23 06:27:09 +00:00
|
|
|
const char *name, *subkey;
|
2020-04-10 19:44:28 +00:00
|
|
|
size_t namelen;
|
2008-08-02 08:08:38 +00:00
|
|
|
|
2013-01-23 06:27:09 +00:00
|
|
|
if (parse_config_key(var, "man", &name, &namelen, &subkey) < 0 || !name)
|
2009-04-23 13:49:06 +00:00
|
|
|
return 0;
|
2008-08-02 08:08:38 +00:00
|
|
|
|
2013-01-23 06:27:09 +00:00
|
|
|
if (!strcmp(subkey, "path")) {
|
2008-08-02 08:08:38 +00:00
|
|
|
if (!value)
|
|
|
|
return config_error_nonbool(var);
|
2013-01-23 06:27:09 +00:00
|
|
|
return add_man_viewer_path(name, namelen, value);
|
2008-08-02 08:08:38 +00:00
|
|
|
}
|
2013-01-23 06:27:09 +00:00
|
|
|
if (!strcmp(subkey, "cmd")) {
|
2008-08-02 08:08:38 +00:00
|
|
|
if (!value)
|
|
|
|
return config_error_nonbool(var);
|
2013-01-23 06:27:09 +00:00
|
|
|
return add_man_viewer_cmd(name, namelen, value);
|
2008-08-02 08:08:38 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
static int git_help_config(const char *var, const char *value, void *cb)
|
|
|
|
{
|
2013-11-30 20:55:40 +00:00
|
|
|
if (starts_with(var, "column."))
|
2012-04-13 10:54:37 +00:00
|
|
|
return git_column_config(var, value, "help", &colopts);
|
2008-08-02 08:08:38 +00:00
|
|
|
if (!strcmp(var, "help.format")) {
|
|
|
|
if (!value)
|
|
|
|
return config_error_nonbool(var);
|
|
|
|
help_format = parse_help_format(value);
|
|
|
|
return 0;
|
|
|
|
}
|
2012-06-28 06:58:02 +00:00
|
|
|
if (!strcmp(var, "help.htmlpath")) {
|
|
|
|
if (!value)
|
|
|
|
return config_error_nonbool(var);
|
|
|
|
html_path = xstrdup(value);
|
|
|
|
return 0;
|
|
|
|
}
|
2008-08-02 08:08:38 +00:00
|
|
|
if (!strcmp(var, "man.viewer")) {
|
|
|
|
if (!value)
|
|
|
|
return config_error_nonbool(var);
|
|
|
|
add_man_viewer(value);
|
|
|
|
return 0;
|
|
|
|
}
|
2013-11-30 20:55:40 +00:00
|
|
|
if (starts_with(var, "man."))
|
2008-08-02 08:08:38 +00:00
|
|
|
return add_man_viewer_info(var, value);
|
|
|
|
|
|
|
|
return git_default_config(var, value, cb);
|
|
|
|
}
|
|
|
|
|
2008-08-28 17:17:46 +00:00
|
|
|
static struct cmdnames main_cmds, other_cmds;
|
2008-08-02 08:08:38 +00:00
|
|
|
|
|
|
|
static int is_git_command(const char *s)
|
|
|
|
{
|
2014-01-02 16:17:11 +00:00
|
|
|
if (is_builtin(s))
|
|
|
|
return 1;
|
|
|
|
|
2014-01-02 16:16:30 +00:00
|
|
|
load_command_list("git-", &main_cmds, &other_cmds);
|
2008-08-02 08:08:38 +00:00
|
|
|
return is_in_cmdlist(&main_cmds, s) ||
|
|
|
|
is_in_cmdlist(&other_cmds, s);
|
|
|
|
}
|
|
|
|
|
|
|
|
static const char *cmd_to_page(const char *git_cmd)
|
|
|
|
{
|
|
|
|
if (!git_cmd)
|
|
|
|
return "git";
|
2013-11-30 20:55:40 +00:00
|
|
|
else if (starts_with(git_cmd, "git"))
|
2008-08-02 08:08:38 +00:00
|
|
|
return git_cmd;
|
|
|
|
else if (is_git_command(git_cmd))
|
2015-09-24 21:07:14 +00:00
|
|
|
return xstrfmt("git-%s", git_cmd);
|
2008-08-02 08:08:38 +00:00
|
|
|
else
|
2015-09-24 21:07:14 +00:00
|
|
|
return xstrfmt("git%s", git_cmd);
|
2008-08-02 08:08:38 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static void setup_man_path(void)
|
|
|
|
{
|
2008-10-09 19:12:12 +00:00
|
|
|
struct strbuf new_path = STRBUF_INIT;
|
2008-08-02 08:08:38 +00:00
|
|
|
const char *old_path = getenv("MANPATH");
|
2014-11-24 19:33:54 +00:00
|
|
|
char *git_man_path = system_path(GIT_MAN_PATH);
|
2008-08-02 08:08:38 +00:00
|
|
|
|
|
|
|
/* 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. */
|
2014-11-24 19:33:54 +00:00
|
|
|
strbuf_addstr(&new_path, git_man_path);
|
2008-08-02 08:08:38 +00:00
|
|
|
strbuf_addch(&new_path, ':');
|
|
|
|
if (old_path)
|
|
|
|
strbuf_addstr(&new_path, old_path);
|
|
|
|
|
2014-11-24 19:33:54 +00:00
|
|
|
free(git_man_path);
|
2008-08-02 08:08:38 +00:00
|
|
|
setenv("MANPATH", new_path.buf, 1);
|
|
|
|
|
|
|
|
strbuf_release(&new_path);
|
|
|
|
}
|
|
|
|
|
|
|
|
static void exec_viewer(const char *name, const char *page)
|
|
|
|
{
|
|
|
|
const char *info = get_man_viewer_info(name);
|
|
|
|
|
|
|
|
if (!strcasecmp(name, "man"))
|
|
|
|
exec_man_man(info, page);
|
|
|
|
else if (!strcasecmp(name, "woman"))
|
|
|
|
exec_woman_emacs(info, page);
|
|
|
|
else if (!strcasecmp(name, "konqueror"))
|
|
|
|
exec_man_konqueror(info, page);
|
|
|
|
else if (info)
|
|
|
|
exec_man_cmd(info, page);
|
|
|
|
else
|
2012-04-23 12:30:24 +00:00
|
|
|
warning(_("'%s': unknown man viewer."), name);
|
2008-08-02 08:08:38 +00:00
|
|
|
}
|
|
|
|
|
2021-07-04 15:39:12 +00:00
|
|
|
static void show_man_page(const char *page)
|
2008-08-02 08:08:38 +00:00
|
|
|
{
|
|
|
|
struct man_viewer_list *viewer;
|
2008-08-29 15:00:43 +00:00
|
|
|
const char *fallback = getenv("GIT_MAN_VIEWER");
|
2008-08-02 08:08:38 +00:00
|
|
|
|
|
|
|
setup_man_path();
|
|
|
|
for (viewer = man_viewer_list; viewer; viewer = viewer->next)
|
|
|
|
{
|
|
|
|
exec_viewer(viewer->name, page); /* will return when unable */
|
|
|
|
}
|
2008-08-29 15:00:43 +00:00
|
|
|
if (fallback)
|
|
|
|
exec_viewer(fallback, page);
|
2008-08-02 08:08:38 +00:00
|
|
|
exec_viewer("man", page);
|
2012-04-23 12:30:24 +00:00
|
|
|
die(_("no man viewer handled the request"));
|
2008-08-02 08:08:38 +00:00
|
|
|
}
|
|
|
|
|
2021-07-04 15:39:12 +00:00
|
|
|
static void show_info_page(const char *page)
|
2008-08-02 08:08:38 +00:00
|
|
|
{
|
2009-01-18 12:00:09 +00:00
|
|
|
setenv("INFOPATH", system_path(GIT_INFO_PATH), 1);
|
2010-07-24 15:20:23 +00:00
|
|
|
execlp("info", "info", "gitman", page, (char *)NULL);
|
2012-04-23 12:30:24 +00:00
|
|
|
die(_("no info viewer handled the request"));
|
2008-08-02 08:08:38 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static void get_html_page_path(struct strbuf *page_path, const char *page)
|
|
|
|
{
|
|
|
|
struct stat st;
|
2014-11-24 19:33:54 +00:00
|
|
|
char *to_free = NULL;
|
|
|
|
|
2012-06-28 06:58:02 +00:00
|
|
|
if (!html_path)
|
2014-11-24 19:33:54 +00:00
|
|
|
html_path = to_free = system_path(GIT_HTML_PATH);
|
2008-08-02 08:08:38 +00:00
|
|
|
|
|
|
|
/* Check that we have a git documentation directory. */
|
2012-06-28 06:58:03 +00:00
|
|
|
if (!strstr(html_path, "://")) {
|
|
|
|
if (stat(mkpath("%s/git.html", html_path), &st)
|
|
|
|
|| !S_ISREG(st.st_mode))
|
|
|
|
die("'%s': not a documentation directory.", html_path);
|
|
|
|
}
|
2008-08-02 08:08:38 +00:00
|
|
|
|
|
|
|
strbuf_init(page_path, 0);
|
|
|
|
strbuf_addf(page_path, "%s/%s.html", html_path, page);
|
2014-11-24 19:33:54 +00:00
|
|
|
free(to_free);
|
2008-08-02 08:08:38 +00:00
|
|
|
}
|
|
|
|
|
2009-06-18 17:28:43 +00:00
|
|
|
static void open_html(const char *path)
|
2008-08-02 08:08:38 +00:00
|
|
|
{
|
2010-07-24 15:20:23 +00:00
|
|
|
execl_git_cmd("web--browse", "-c", "help.browser", path, (char *)NULL);
|
2008-08-02 08:08:38 +00:00
|
|
|
}
|
|
|
|
|
2021-07-04 15:39:12 +00:00
|
|
|
static void show_html_page(const char *page)
|
2008-08-02 08:08:38 +00:00
|
|
|
{
|
|
|
|
struct strbuf page_path; /* it leaks but we exec bellow */
|
|
|
|
|
|
|
|
get_html_page_path(&page_path, page);
|
|
|
|
|
|
|
|
open_html(page_path.buf);
|
|
|
|
}
|
|
|
|
|
2016-08-26 17:58:35 +00:00
|
|
|
static const char *check_git_cmd(const char* cmd)
|
|
|
|
{
|
|
|
|
char *alias;
|
|
|
|
|
|
|
|
if (is_git_command(cmd))
|
|
|
|
return cmd;
|
|
|
|
|
|
|
|
alias = alias_lookup(cmd);
|
|
|
|
if (alias) {
|
2018-10-09 11:59:07 +00:00
|
|
|
const char **argv;
|
|
|
|
int count;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* handle_builtin() in git.c rewrites "git cmd --help"
|
|
|
|
* to "git help --exclude-guides cmd", so we can use
|
|
|
|
* exclude_guides to distinguish "git cmd --help" from
|
|
|
|
* "git help cmd". In the latter case, or if cmd is an
|
|
|
|
* alias for a shell command, just print the alias
|
|
|
|
* definition.
|
|
|
|
*/
|
|
|
|
if (!exclude_guides || alias[0] == '!') {
|
|
|
|
printf_ln(_("'%s' is aliased to '%s'"), cmd, alias);
|
|
|
|
free(alias);
|
|
|
|
exit(0);
|
|
|
|
}
|
|
|
|
/*
|
|
|
|
* Otherwise, we pretend that the command was "git
|
|
|
|
* word0 --help". We use split_cmdline() to get the
|
|
|
|
* first word of the alias, to ensure that we use the
|
|
|
|
* same rules as when the alias is actually
|
|
|
|
* used. split_cmdline() modifies alias in-place.
|
|
|
|
*/
|
|
|
|
fprintf_ln(stderr, _("'%s' is aliased to '%s'"), cmd, alias);
|
|
|
|
count = split_cmdline(alias, &argv);
|
|
|
|
if (count < 0)
|
|
|
|
die(_("bad alias.%s string: %s"), cmd,
|
|
|
|
split_cmdline_strerror(count));
|
|
|
|
free(argv);
|
|
|
|
UNLEAK(alias);
|
|
|
|
return alias;
|
2016-08-26 17:58:35 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if (exclude_guides)
|
|
|
|
return help_unknown_cmd(cmd);
|
|
|
|
|
|
|
|
return cmd;
|
|
|
|
}
|
|
|
|
|
2008-08-02 08:08:38 +00:00
|
|
|
int cmd_help(int argc, const char **argv, const char *prefix)
|
|
|
|
{
|
|
|
|
int nongit;
|
2010-01-09 05:10:05 +00:00
|
|
|
enum help_format parsed_help_format;
|
2021-07-04 15:39:12 +00:00
|
|
|
const char *page;
|
2008-08-02 08:08:38 +00:00
|
|
|
|
2009-05-23 18:53:12 +00:00
|
|
|
argc = parse_options(argc, argv, prefix, builtin_help_options,
|
2008-08-02 08:08:38 +00:00
|
|
|
builtin_help_usage, 0);
|
2010-01-09 05:10:05 +00:00
|
|
|
parsed_help_format = help_format;
|
2008-08-02 08:08:38 +00:00
|
|
|
|
2021-09-21 22:40:34 +00:00
|
|
|
/* Incompatible options */
|
|
|
|
if (show_all && show_config)
|
|
|
|
usage_msg_opt(_("--config and --all cannot be combined"),
|
|
|
|
builtin_help_usage, builtin_help_options);
|
|
|
|
|
2021-09-21 22:40:35 +00:00
|
|
|
if (show_all && show_guides)
|
|
|
|
usage_msg_opt(_("--config and --guides cannot be combined"),
|
|
|
|
builtin_help_usage, builtin_help_options);
|
|
|
|
|
2021-09-21 22:40:34 +00:00
|
|
|
if (show_config && show_guides)
|
|
|
|
usage_msg_opt(_("--config and --guides cannot be combined"),
|
|
|
|
builtin_help_usage, builtin_help_options);
|
|
|
|
|
2021-09-21 22:40:32 +00:00
|
|
|
/* Options that take no further arguments */
|
2021-09-21 22:40:34 +00:00
|
|
|
if (argc && show_config)
|
|
|
|
usage_msg_opt(_("--config cannot be combined with command or guide names"),
|
|
|
|
builtin_help_usage, builtin_help_options);
|
2021-09-21 22:40:32 +00:00
|
|
|
if (argc && show_guides)
|
2021-09-21 22:40:34 +00:00
|
|
|
usage_msg_opt(_("--guides cannot be combined with command or guide names"),
|
2021-09-21 22:40:32 +00:00
|
|
|
builtin_help_usage, builtin_help_options);
|
|
|
|
|
2008-08-02 08:08:38 +00:00
|
|
|
if (show_all) {
|
2012-04-13 10:54:37 +00:00
|
|
|
git_config(git_help_config, NULL);
|
2018-05-20 18:40:01 +00:00
|
|
|
if (verbose) {
|
|
|
|
setup_pager();
|
|
|
|
list_all_cmds_help();
|
|
|
|
return 0;
|
|
|
|
}
|
2012-04-23 12:30:24 +00:00
|
|
|
printf(_("usage: %s%s"), _(git_usage_string), "\n\n");
|
2014-01-02 16:16:30 +00:00
|
|
|
load_command_list("git-", &main_cmds, &other_cmds);
|
2012-05-03 22:13:31 +00:00
|
|
|
list_commands(colopts, &main_cmds, &other_cmds);
|
2013-04-02 22:39:49 +00:00
|
|
|
}
|
|
|
|
|
2021-09-21 22:40:34 +00:00
|
|
|
if (show_guides)
|
|
|
|
list_guides_help();
|
|
|
|
|
|
|
|
if (show_all || show_guides) {
|
|
|
|
printf("%s\n", _(git_more_info_string));
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2018-05-26 13:55:24 +00:00
|
|
|
if (show_config) {
|
2018-05-26 13:55:28 +00:00
|
|
|
int for_human = show_config == 1;
|
|
|
|
|
|
|
|
if (!for_human) {
|
|
|
|
list_config_help(for_human);
|
|
|
|
return 0;
|
|
|
|
}
|
2018-05-26 13:55:24 +00:00
|
|
|
setup_pager();
|
2018-05-26 13:55:28 +00:00
|
|
|
list_config_help(for_human);
|
2018-05-26 13:55:24 +00:00
|
|
|
printf("\n%s\n", _("'git help config' for more information"));
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2008-08-02 08:08:38 +00:00
|
|
|
if (!argv[0]) {
|
2012-04-23 12:30:24 +00:00
|
|
|
printf(_("usage: %s%s"), _(git_usage_string), "\n\n");
|
2008-08-02 08:08:38 +00:00
|
|
|
list_common_cmds_help();
|
2012-04-23 12:30:24 +00:00
|
|
|
printf("\n%s\n", _(git_more_info_string));
|
2008-08-02 08:08:38 +00:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2009-12-01 19:27:34 +00:00
|
|
|
setup_git_directory_gently(&nongit);
|
|
|
|
git_config(git_help_config, NULL);
|
|
|
|
|
2012-06-22 12:48:46 +00:00
|
|
|
if (parsed_help_format != HELP_FORMAT_NONE)
|
2010-01-09 05:10:05 +00:00
|
|
|
help_format = parsed_help_format;
|
2012-06-22 12:48:46 +00:00
|
|
|
if (help_format == HELP_FORMAT_NONE)
|
|
|
|
help_format = parse_help_format(DEFAULT_HELP_FORMAT);
|
2010-01-09 05:10:05 +00:00
|
|
|
|
2016-08-26 17:58:35 +00:00
|
|
|
argv[0] = check_git_cmd(argv[0]);
|
2008-08-02 08:08:38 +00:00
|
|
|
|
2021-07-04 15:39:12 +00:00
|
|
|
page = cmd_to_page(argv[0]);
|
2008-08-02 08:08:38 +00:00
|
|
|
switch (help_format) {
|
2010-01-09 05:10:05 +00:00
|
|
|
case HELP_FORMAT_NONE:
|
2008-08-02 08:08:38 +00:00
|
|
|
case HELP_FORMAT_MAN:
|
2021-07-04 15:39:12 +00:00
|
|
|
show_man_page(page);
|
2008-08-02 08:08:38 +00:00
|
|
|
break;
|
|
|
|
case HELP_FORMAT_INFO:
|
2021-07-04 15:39:12 +00:00
|
|
|
show_info_page(page);
|
2008-08-02 08:08:38 +00:00
|
|
|
break;
|
|
|
|
case HELP_FORMAT_WEB:
|
2021-07-04 15:39:12 +00:00
|
|
|
show_html_page(page);
|
2008-08-02 08:08:38 +00:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|