@matheusbsbs / matheus-bagliano / commits / acf7828e38

built-ins: consistently add "\n" between "usage" and options

Change commands in the "diff" family and "rev-list" to separate the usage information and option listing with an empty line. In the case of "git diff -h" we did this already (but let's use a consistent "\n" pattern there), for the rest these are now consistent with how the parse_options() API would emit usage. As we'll see in a subsequent commit this also helps to make the "git <cmd> -h" output more easily machine-readable, as we can assume that the usage information is separated from the options by an empty line. Note that "COMMON_DIFF_OPTIONS_HELP" starts with a "\n", so the seeming omission of a "\n" here is correct, the second one is provided by the macro. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Ævar Arnfjörð Bjarmason committed Oct 13, 2022 at 17:39 UTC acf7828e388a67f6a7a025dc68b7012a6c3eee75

5 files changed +6 -1

builtin/diff-files.c

@@ -15,6 +15,7 @@

16 static const char diff_files_usage[] =

17 "git diff-files [-q] [-0 | -1 | -2 | -3 | -c | --cc] [<common-diff-options>] [<path>...]"

18 +"\n"

19 COMMON_DIFF_OPTIONS_HELP;

21 int cmd_diff_files(int argc, const char **argv, const char *prefix)

builtin/diff-index.c

@@ -11,6 +11,7 @@

11 static const char diff_cache_usage[] =

12 "git diff-index [-m] [--cached] "

13 "[<common-diff-options>] <tree-ish> [<path>...]"

14 +"\n"

15 COMMON_DIFF_OPTIONS_HELP;

17 int cmd_diff_index(int argc, const char **argv, const char *prefix)

builtin/diff-tree.c

@@ -85,6 +85,7 @@ static int diff_tree_stdin(char *line)

85 static const char diff_tree_usage[] =

86 "git diff-tree [--stdin] [-m] [-c | --cc] [-s] [-v] [--pretty] [-t] [-r] [--root] "

87 "[<common-diff-options>] <tree-ish> [<tree-ish>] [<path>...]\n"

88 +"\n"

89 " -r diff recursively\n"

90 " -c show combined diff for merge commits\n"

91 " --cc show combined diff for merge commits removing uninteresting hunks\n"

builtin/diff.c

+2 -1

@@ -30,7 +30,8 @@ static const char builtin_diff_usage[] =

30 " or: git diff [<options>] [--merge-base] <commit> [<commit>...] <commit> [--] [<path>...]\n"

31 " or: git diff [<options>] <commit>...<commit> [--] [<path>...]\n"

32 " or: git diff [<options>] <blob> <blob>\n"

33 -" or: git diff [<options>] --no-index [--] <path> <path>\n"

33 +" or: git diff [<options>] --no-index [--] <path> <path>"

34 +"\n"

35 COMMON_DIFF_OPTIONS_HELP;

37 static const char *blob_path(struct object_array_entry *entry)

builtin/rev-list.c

@@ -21,6 +21,7 @@

22 static const char rev_list_usage[] =

23 "git rev-list [<options>] <commit-id>... [-- <path>...]\n"

24 +"\n"

25 " limiting output:\n"

26 " --max-count=<n>\n"

27 " --max-age=<epoch>\n"