summaryrefslogtreecommitdiff
path: root/help.c
diff options
context:
space:
mode:
authorChristian Couder <chriscool@tuxfamily.org>2007-12-02 05:07:55 (GMT)
committerJunio C Hamano <gitster@pobox.com>2007-12-09 09:19:44 (GMT)
commit5d6491c7c7536ab930a6e9ce2ec3b5249d4c283f (patch)
tree75c099f90edef7ea8debf2a5021f0fc661eb0b05 /help.c
parent45533d2694d480be86112f2da36d555e7373ba24 (diff)
downloadgit-5d6491c7c7536ab930a6e9ce2ec3b5249d4c283f.zip
git-5d6491c7c7536ab930a6e9ce2ec3b5249d4c283f.tar.gz
git-5d6491c7c7536ab930a6e9ce2ec3b5249d4c283f.tar.bz2
git-help: add -w|--web option to display html man page in a browser.
Now when using "git help -w cmd", we will try to show the HTML man page "git-cmd.html" in your prefered web browser. To do that "help.c" code will call a new shell script "git-browse-help". This currently works only if the HTML versions of the man page have been installed in $(htmldir) (typically "/usr/share/doc/git-doc"), so new target to do that is added to "Documentation/Makefile". The browser to use can be configured using the "web.browser" config variable. We try to open a new tab in an existing web browser, if possible. The code in "git-browse-help" is heavily stolen from "git-mergetool" by Theodore Y. Ts'o. Thanks. Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'help.c')
-rw-r--r--help.c34
1 files changed, 19 insertions, 15 deletions
diff --git a/help.c b/help.c
index 0f1cb71..ec0d015 100644
--- a/help.c
+++ b/help.c
@@ -241,7 +241,9 @@ void list_common_cmds_help(void)
static const char *cmd_to_page(const char *git_cmd)
{
- if (!prefixcmp(git_cmd, "git"))
+ if (!git_cmd)
+ return "git";
+ else if (!prefixcmp(git_cmd, "git"))
return git_cmd;
else {
int page_len = strlen(git_cmd) + 4;
@@ -265,6 +267,12 @@ static void show_info_page(const char *git_cmd)
execlp("info", "info", 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);
@@ -277,31 +285,27 @@ int cmd_version(int argc, const char **argv, const char *prefix)
return 0;
}
-static void check_help_cmd(const char *help_cmd)
+int cmd_help(int argc, const char **argv, const char *prefix)
{
- if (!help_cmd) {
+ const char *help_cmd = argv[1];
+
+ if (argc < 2) {
printf("usage: %s\n\n", git_usage_string);
list_common_cmds_help();
exit(0);
}
- else if (!strcmp(help_cmd, "--all") || !strcmp(help_cmd, "-a")) {
+ if (!strcmp(help_cmd, "--all") || !strcmp(help_cmd, "-a")) {
printf("usage: %s\n\n", git_usage_string);
list_commands();
- exit(0);
}
-}
-
-int cmd_help(int argc, const char **argv, const char *prefix)
-{
- const char *help_cmd = argc > 1 ? argv[1] : NULL;
- check_help_cmd(help_cmd);
- if (!strcmp(help_cmd, "--info") || !strcmp(help_cmd, "-i")) {
- help_cmd = argc > 2 ? argv[2] : NULL;
- check_help_cmd(help_cmd);
+ else if (!strcmp(help_cmd, "--web") || !strcmp(help_cmd, "-w")) {
+ show_html_page(argc > 2 ? argv[2] : NULL);
+ }
- show_info_page(help_cmd);
+ else if (!strcmp(help_cmd, "--info") || !strcmp(help_cmd, "-i")) {
+ show_info_page(argc > 2 ? argv[2] : NULL);
}
else