mirror/ git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-05-07 01:06:09 +02:00
Code

help: don't print "\n" before single-section output 

Fix a formatting regression in 1b81d8cb19 (help: use command-list.txt
for the source of guides, 2018-05-20). Adjust the output of "git help
--guides" and any other future single-section commands so that a
newline isn't inserted before the only section being printed.

This changes the output from:

    $ git help --guides

    The Git concept guides are:
    [...]

To:

    $ git help --guides
    The Git concept guides are:
    [...]

That we started printing an extra "\n" in 1b81d8cb19 wasn't intended,
but an emergent effect of moving all of the printing of "git help"
output to code that was ready to handle printing N sections.

With 1b81d8cb19 we started using the "print_cmd_by_category()"
function added earlier in the same series, or in cfb22a02ab (help:
use command-list.h for common command list, 2018-05-10).

Fixing this formatting nit is easy enough. Let's have all of the
output that would like to be "\n"-separated from other lines emit its
own "\n". We then adjust "print_cmd_by_category()" to only print a
"\n" to delimit the sections it's printing out.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Ævar Arnfjörð Bjarmason 2022-02-21 20:38:52 +01:00 committed by Junio C Hamano
parent 1ce590133b
commit 93de1b6999
2 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
help.c
View File

@ -124,7 +124,8 @@ static void print_cmd_by_category(const struct category_description *catdesc,
uint32_t mask = catdesc[i].category;
const char *desc = catdesc[i].desc;
putchar('\n');
if (i)
putchar('\n');
puts(_(desc));
print_command_list(cmds, mask, longest);
}
@ -328,6 +329,7 @@ void list_commands(struct cmdnames *main_cmds, struct cmdnames *other_cmds)
void list_common_cmds_help(void)
{
puts(_("These are common Git commands used in various situations:"));
putchar('\n');
print_cmd_by_category(common_categories, NULL);
}
@ -481,6 +483,7 @@ void list_all_cmds_help(int show_external_commands, int show_aliases)
int longest;
puts(_("See 'git help <command>' to read about a specific subcommand"));
putchar('\n');
print_cmd_by_category(main_categories, &longest);
if (show_external_commands)

1
t/t0012-help.sh
View File

@ -226,7 +226,6 @@ test_expect_success "'git help -a' section spacing" '
test_expect_success "'git help -g' section spacing" '
test_section_spacing_trailer git help -g <<-\EOF &&
The Git concept guides are:
EOF