[PATCH] branch: advice using git-help(1) instead of man(1)
- From
- kristofferhaugsbakk@fastmail.com <kristofferhaugsbakk@fastmail.com>
- Date
- Nov 28, 2025, 12:54 UTC
- Message-ID
- <advice_git-help.64@msgid.xyz>
From: Kristoffer Haugsbakk <code@khaugsbakk.name>
8fbd903e (branch: advise about ref syntax rules, 2024-03-05) added an advice about checking git-check-ref-format(1) for the ref syntax rules. The advice uses man(1). It’s better to use Git’s own git-help(1) instead of an external command.
Also change to using single quotes (') to quote the command since that is more conventional.
While here let’s also update the test to use `{SQ}`, which is more readable and easier to edit.
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name> --- branch.c | 2 +- builtin/branch.c | 2 +- t/t3200-branch.sh | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/branch.c b/branch.c index 26be3583471..243db7d0fc0 100644 --- a/branch.c +++ b/branch.c @@ -375,7 +375,7 @@ int validate_branchname(const char *name, struct strbuf *ref) if (check_branch_ref(ref, name)) { int code = die_message(_("'%s' is not a valid branch name"), name); advise_if_enabled(ADVICE_REF_SYNTAX, - _("See `man git check-ref-format`")); + _("See 'git help check-ref-format'")); exit(code); } diff --git a/builtin/branch.c b/builtin/branch.c index 9fcf04bebb2..c577b5d20f2 100644 --- a/builtin/branch.c +++ b/builtin/branch.c @@ -591,7 +591,7 @@ static void copy_or_rename_branch(const char *oldname, const char *newname, int else { int code = die_message(_("invalid branch name: '%s'"), oldname); advise_if_enabled(ADVICE_REF_SYNTAX, - _("See `man git check-ref-format`")); + _("See 'git help check-ref-format'")); exit(code); } } diff --git a/t/t3200-branch.sh b/t/t3200-branch.sh index f3e720dc10d..c58e505c43f 100755 --- a/t/t3200-branch.sh +++ b/t/t3200-branch.sh @@ -1707,9 +1707,9 @@ test_expect_success '--track overrides branch.autoSetupMerge' ' ' test_expect_success 'errors if given a bad branch name' ' - cat <<-\EOF >expect && - fatal: '\''foo..bar'\'' is not a valid branch name - hint: See `man git check-ref-format` + cat <<-EOF >expect && + fatal: ${SQ}foo..bar${SQ} is not a valid branch name + hint: See ${SQ}git help check-ref-format${SQ} hint: Disable this message with "git config set advice.refSyntax false" EOF test_must_fail git branch foo..bar >actual 2>&1 && base-commit: 9a2fb147f2c61d0cab52c883e7e26f5b7948e3ed
-- 2.52.0.10.g08704017180