[v2] diff: add diff.srcprefix and diff.dstprefix configuration variables

Commit Message

Peter Hutterer March 12, 2024, 12:57 a.m. UTC

Allow the default prefixes "a/" and "b/" to be tweaked by the
diff.srcprefix and diff.dstprefix configuration variables.

Signed-off-by: Peter Hutterer <[e-mail]>
---
Changes to v1:
- note default in documentation
- drop the custom prefix function, change the defaults instead
- commit message: options -> configuration variables

Junio: all of your comments squashed in as requested, thanks for the
review and suggestions, much simpler now.

 Documentation/config/diff.txt |  6 ++++++
 diff.c                        | 12 ++++++++++--
 t/t4013-diff-various.sh       | 20 ++++++++++++++++++++
 3 files changed, 36 insertions(+), 2 deletions(-)

Comments

Junio C Hamano March 12, 2024, 7:23 p.m. UTC | #1

Peter Hutterer <[e-mail]> writes:

> Allow the default prefixes "a/" and "b/" to be tweaked by the
> diff.srcprefix and diff.dstprefix configuration variables.
>
> Signed-off-by: Peter Hutterer <[e-mail]>
> ---
> Changes to v1:
> - note default in documentation
> - drop the custom prefix function, change the defaults instead
> - commit message: options -> configuration variables

Looking good.  Will queue.  Thanks.

Dragan Simic March 12, 2024, 7:29 p.m. UTC | #2

On 2024-03-12 20:23, Junio C Hamano wrote:
> Peter Hutterer <[e-mail]> writes:
> 
>> Allow the default prefixes "a/" and "b/" to be tweaked by the
>> diff.srcprefix and diff.dstprefix configuration variables.

If I may interject, albeit a bit late, we should use "diff.srcPrefix"
and "diff.dstPrefix" as the configuration option names.

>> Signed-off-by: Peter Hutterer <[e-mail]>
>> ---
>> Changes to v1:
>> - note default in documentation
>> - drop the custom prefix function, change the defaults instead
>> - commit message: options -> configuration variables
> 
> Looking good.  Will queue.  Thanks.

Patch

diff --git a/Documentation/config/diff.txt b/Documentation/config/diff.txt
index 6c7e09a1ef5e..43d94df19876 100644
--- a/Documentation/config/diff.txt
+++ b/Documentation/config/diff.txt
@@ -111,6 +111,12 @@  diff.mnemonicPrefix::
 diff.noprefix::
 	If set, 'git diff' does not show any source or destination prefix.
 
+diff.srcprefix::
+	If set, 'git diff' uses this source prefix. Defaults to 'a/'.
+
+diff.dstprefix::
+	If set, 'git diff' uses this destination prefix. Defaults to 'b/'.
+
 diff.relative::
 	If set to 'true', 'git diff' does not show changes outside of the directory
 	and show pathnames relative to the current directory.
diff --git a/diff.c b/diff.c
index e50def45383e..4439b1a95864 100644
--- a/diff.c
+++ b/diff.c
@@ -62,6 +62,8 @@  static const char *diff_order_file_cfg;
 int diff_auto_refresh_index = 1;
 static int diff_mnemonic_prefix;
 static int diff_no_prefix;
+static const char *diff_src_prefix = "a/";
+static const char *diff_dst_prefix = "b/";
 static int diff_relative;
 static int diff_stat_name_width;
 static int diff_stat_graph_width;
@@ -408,6 +410,12 @@  int git_diff_ui_config(const char *var, const char *value,
 		diff_no_prefix = git_config_bool(var, value);
 		return 0;
 	}
+	if (!strcmp(var, "diff.srcprefix")) {
+		return git_config_string(&diff_src_prefix, var, value);
+	}
+	if (!strcmp(var, "diff.dstprefix")) {
+		return git_config_string(&diff_dst_prefix, var, value);
+	}
 	if (!strcmp(var, "diff.relative")) {
 		diff_relative = git_config_bool(var, value);
 		return 0;
@@ -3425,8 +3433,8 @@  void diff_set_noprefix(struct diff_options *options)
 
 void diff_set_default_prefix(struct diff_options *options)
 {
-	options->a_prefix = "a/";
-	options->b_prefix = "b/";
+	options->a_prefix = diff_src_prefix;
+	options->b_prefix = diff_dst_prefix;
 }
 
 struct userdiff_driver *get_textconv(struct repository *r,
diff --git a/t/t4013-diff-various.sh b/t/t4013-diff-various.sh
index 1e3b2dbea484..86834186fdba 100755
--- a/t/t4013-diff-various.sh
+++ b/t/t4013-diff-various.sh
@@ -663,6 +663,26 @@  test_expect_success 'diff --default-prefix overrides diff.mnemonicprefix' '
 	check_prefix actual a/file0 b/file0
 '
 
+test_expect_success 'diff respects diff.srcprefix' '
+	git -c diff.srcprefix=x/ diff >actual &&
+	check_prefix actual x/file0 b/file0
+'
+
+test_expect_success 'diff respects diff.dstprefix' '
+	git -c diff.dstprefix=y/ diff >actual &&
+	check_prefix actual a/file0 y/file0
+'
+
+test_expect_success 'diff src/dstprefix ignored with diff.noprefix' '
+	git -c diff.dstprefix=y/ -c diff.srcprefix=x/ -c diff.noprefix diff >actual &&
+	check_prefix actual file0 file0
+'
+
+test_expect_success 'diff src/dstprefix ignored with diff.mnemonicprefix' '
+	git -c diff.dstprefix=x/ -c diff.srcprefix=y/ -c diff.mnemonicprefix diff >actual &&
+	check_prefix actual i/file0 w/file0
+'
+
 test_expect_success 'diff --no-renames cannot be abbreviated' '
 	test_expect_code 129 git diff --no-rename >actual 2>error &&
 	test_must_be_empty actual &&