Skip to content

Commit bd42622

Browse files
committed
Merge branch 'ma/help-w-check-for-requested-page'
The error in "git help no-such-git-command" is handled better. * ma/help-w-check-for-requested-page: help: make sure local html page exists before calling external processes
2 parents c2e7990 + a3952f8 commit bd42622

File tree

2 files changed

+22
-3
lines changed

2 files changed

+22
-3
lines changed

builtin/help.c

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -467,11 +467,14 @@ static void get_html_page_path(struct strbuf *page_path, const char *page)
467467
if (!html_path)
468468
html_path = to_free = system_path(GIT_HTML_PATH);
469469

470-
/* Check that we have a git documentation directory. */
470+
/*
471+
* Check that the page we're looking for exists.
472+
*/
471473
if (!strstr(html_path, "://")) {
472-
if (stat(mkpath("%s/git.html", html_path), &st)
474+
if (stat(mkpath("%s/%s.html", html_path, page), &st)
473475
|| !S_ISREG(st.st_mode))
474-
die("'%s': not a documentation directory.", html_path);
476+
die("'%s/%s.html': documentation file not found.",
477+
html_path, page);
475478
}
476479

477480
strbuf_init(page_path, 0);

t/t0012-help.sh

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,22 @@ test_expect_success 'git help -g' '
7373
test_i18ngrep "^ tutorial " help.output
7474
'
7575

76+
test_expect_success 'git help fails for non-existing html pages' '
77+
configure_help &&
78+
mkdir html-empty &&
79+
test_must_fail git -c help.htmlpath=html-empty help status &&
80+
test_must_be_empty test-browser.log
81+
'
82+
83+
test_expect_success 'git help succeeds without git.html' '
84+
configure_help &&
85+
mkdir html-with-docs &&
86+
touch html-with-docs/git-status.html &&
87+
git -c help.htmlpath=html-with-docs help status &&
88+
echo "html-with-docs/git-status.html" >expect &&
89+
test_cmp expect test-browser.log
90+
'
91+
7692
test_expect_success 'generate builtin list' '
7793
git --list-cmds=builtins >builtins
7894
'

0 commit comments

Comments
 (0)