Skip to content

Commit 2da5cbd

Browse files
committed
Merge branch 'sb/diff-orderfile-config'
Allow "git diff -O<file>" to be configured with a new configuration variable. * sb/diff-orderfile-config: diff: add diff.orderfile configuration variable diff: let "git diff -O" read orderfile from any file and fail properly t4056: add new tests for "git diff -O"
2 parents f8c2e3f + 6d8940b commit 2da5cbd

File tree

5 files changed

+125
-15
lines changed

5 files changed

+125
-15
lines changed

Documentation/diff-config.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,11 @@ diff.mnemonicprefix::
9898
diff.noprefix::
9999
If set, 'git diff' does not show any source or destination prefix.
100100

101+
diff.orderfile::
102+
File indicating how to order files within a diff, using
103+
one shell glob pattern per line.
104+
Can be overridden by the '-O' option to linkgit:git-diff[1].
105+
101106
diff.renameLimit::
102107
The number of files to consider when performing the copy/rename
103108
detection; equivalent to the 'git diff' option '-l'.

Documentation/diff-options.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -432,6 +432,9 @@ endif::git-format-patch[]
432432
-O<orderfile>::
433433
Output the patch in the order specified in the
434434
<orderfile>, which has one shell glob pattern per line.
435+
This overrides the `diff.orderfile` configuration variable
436+
(see linkgit:git-config[1]). To cancel `diff.orderfile`,
437+
use `-O/dev/null`.
435438

436439
ifndef::git-format-patch[]
437440
-R::

diff.c

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ static int diff_use_color_default = -1;
3030
static int diff_context_default = 3;
3131
static const char *diff_word_regex_cfg;
3232
static const char *external_diff_cmd_cfg;
33+
static const char *diff_order_file_cfg;
3334
int diff_auto_refresh_index = 1;
3435
static int diff_mnemonic_prefix;
3536
static int diff_no_prefix;
@@ -201,6 +202,8 @@ int git_diff_ui_config(const char *var, const char *value, void *cb)
201202
return git_config_string(&external_diff_cmd_cfg, var, value);
202203
if (!strcmp(var, "diff.wordregex"))
203204
return git_config_string(&diff_word_regex_cfg, var, value);
205+
if (!strcmp(var, "diff.orderfile"))
206+
return git_config_pathname(&diff_order_file_cfg, var, value);
204207

205208
if (!strcmp(var, "diff.ignoresubmodules"))
206209
handle_ignore_submodules_arg(&default_diff_options, value);
@@ -3219,6 +3222,8 @@ void diff_setup(struct diff_options *options)
32193222
options->detect_rename = diff_detect_rename_default;
32203223
options->xdl_opts |= diff_algorithm;
32213224

3225+
options->orderfile = diff_order_file_cfg;
3226+
32223227
if (diff_no_prefix) {
32233228
options->a_prefix = options->b_prefix = "";
32243229
} else if (!diff_mnemonic_prefix) {

diffcore-order.c

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,28 +10,21 @@ static int order_cnt;
1010

1111
static void prepare_order(const char *orderfile)
1212
{
13-
int fd, cnt, pass;
13+
int cnt, pass;
14+
struct strbuf sb = STRBUF_INIT;
1415
void *map;
1516
char *cp, *endp;
16-
struct stat st;
17-
size_t sz;
17+
ssize_t sz;
1818

1919
if (order)
2020
return;
2121

22-
fd = open(orderfile, O_RDONLY);
23-
if (fd < 0)
24-
return;
25-
if (fstat(fd, &st)) {
26-
close(fd);
27-
return;
28-
}
29-
sz = xsize_t(st.st_size);
30-
map = mmap(NULL, sz, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
31-
close(fd);
32-
if (map == MAP_FAILED)
33-
return;
22+
sz = strbuf_read_file(&sb, orderfile, 0);
23+
if (sz < 0)
24+
die_errno(_("failed to read orderfile '%s'"), orderfile);
25+
map = strbuf_detach(&sb, NULL);
3426
endp = (char *) map + sz;
27+
3528
for (pass = 0; pass < 2; pass++) {
3629
cnt = 0;
3730
cp = map;

t/t4056-diff-order.sh

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
#!/bin/sh
2+
3+
test_description='diff order'
4+
5+
. ./test-lib.sh
6+
7+
create_files () {
8+
echo "$1" >a.h &&
9+
echo "$1" >b.c &&
10+
echo "$1" >c/Makefile &&
11+
echo "$1" >d.txt &&
12+
git add a.h b.c c/Makefile d.txt &&
13+
git commit -m"$1"
14+
}
15+
16+
test_expect_success 'setup' '
17+
mkdir c &&
18+
create_files 1 &&
19+
create_files 2 &&
20+
21+
cat >order_file_1 <<-\EOF &&
22+
*Makefile
23+
*.txt
24+
*.h
25+
EOF
26+
27+
cat >order_file_2 <<-\EOF &&
28+
*Makefile
29+
*.h
30+
*.c
31+
EOF
32+
33+
cat >expect_none <<-\EOF &&
34+
a.h
35+
b.c
36+
c/Makefile
37+
d.txt
38+
EOF
39+
40+
cat >expect_1 <<-\EOF &&
41+
c/Makefile
42+
d.txt
43+
a.h
44+
b.c
45+
EOF
46+
47+
cat >expect_2 <<-\EOF
48+
c/Makefile
49+
a.h
50+
b.c
51+
d.txt
52+
EOF
53+
'
54+
55+
test_expect_success "no order (=tree object order)" '
56+
git diff --name-only HEAD^..HEAD >actual &&
57+
test_cmp expect_none actual
58+
'
59+
60+
test_expect_success 'missing orderfile' '
61+
rm -f bogus_file &&
62+
test_must_fail git diff -Obogus_file --name-only HEAD^..HEAD
63+
'
64+
65+
test_expect_success POSIXPERM,SANITY 'unreadable orderfile' '
66+
>unreadable_file &&
67+
chmod -r unreadable_file &&
68+
test_must_fail git diff -Ounreadable_file --name-only HEAD^..HEAD
69+
'
70+
71+
test_expect_success 'orderfile is a directory' '
72+
test_must_fail git diff -O/ --name-only HEAD^..HEAD
73+
'
74+
75+
for i in 1 2
76+
do
77+
test_expect_success "orderfile using option ($i)" '
78+
git diff -Oorder_file_$i --name-only HEAD^..HEAD >actual &&
79+
test_cmp expect_$i actual
80+
'
81+
82+
test_expect_success PIPE "orderfile is fifo ($i)" '
83+
rm -f order_fifo &&
84+
mkfifo order_fifo &&
85+
{
86+
cat order_file_$i >order_fifo &
87+
} &&
88+
git diff -O order_fifo --name-only HEAD^..HEAD >actual &&
89+
wait &&
90+
test_cmp expect_$i actual
91+
'
92+
93+
test_expect_success "orderfile using config ($i)" '
94+
git -c diff.orderfile=order_file_$i diff --name-only HEAD^..HEAD >actual &&
95+
test_cmp expect_$i actual
96+
'
97+
98+
test_expect_success "cancelling configured orderfile ($i)" '
99+
git -c diff.orderfile=order_file_$i diff -O/dev/null --name-only HEAD^..HEAD >actual &&
100+
test_cmp expect_none actual
101+
'
102+
done
103+
104+
test_done

0 commit comments

Comments
 (0)