diff: add config option relative
PATCH 1/1 diff: add config option relative
The diff.relative boolean option set to true to show only changes on the current directory and show relative pathnames.
--- Documentation/config/diff.txt | 4 +++ diff.c | 7 +++++ t/t9904-diff-relative-config.sh | 48 +++++++++++++++++++++++++++++++++ 3 files changed, 59 insertions(+) create mode 100755 t/t9904-diff-relative-config.sh
config/diff.txt +4 -0
@@ -105,6 +105,10 @@ diff.mnemonicPrefix:: diff.noprefix:: If set, 'git diff' does not show any source or destination prefix. +diff.relative:: + If set to "true", 'git diff' does not show changes outside of the directory + and show pathnames relative. + diff.orderFile:: File indicating how to order files within a diff. See the '-O' option to linkgit:git-diff[1] for details.
diff.c +7 -0
@@ -48,6 +48,7 @@ static const char *diff_order_file_cfg;int diff_auto_refresh_index =1 ;static int diff_mnemonic_prefix;static int diff_no_prefix; +static int diff_relative;static int diff_stat_graph_width;static int diff_dirstat_permille_default =30 ;static struct diff_options default_diff_options;
@@ -386,6 +387,10 @@ int git_diff_ui_config(const char *var, const char *value, void *cb) diff_no_prefix =git_config_bool (var, value);return 0 ; } +if (!strcmp (var,"diff.relative" )) { + diff_relative =git_config_bool (var, value); +return 0 ; + }if (!strcmp (var,"diff.statgraphwidth" )) { diff_stat_graph_width =git_config_int (var, value);return 0 ;
@@ -4558,6 +4563,8 @@ void repo_diff_setup(struct repository *r, struct diff_options *options) options->b_prefix ="b/" ; } + options->flags.relative_name = diff_relative; + options->color_moved = diff_color_moved_default; options->color_moved_ws_handling = diff_color_moved_ws_default;
t9904-diff-relative-config.sh new file +48 -0
48 lines not on this page · raw message
Signature · 1 line
2.26.2
Hi Laurent,
Quoted 16 lines · Laurent Arnoud
The
diff.relativeboolean option set totrueto show only changes on the current directory and show relative pathnames.Signed-off-by Laurent Arnoud <[email protected]>--- Documentation/config/diff.txt | 4 +++ diff.c | 7 +++++ t/t9904-diff-relative-config.sh | 48 +++++++++++++++++++++++++++++++++ 3 files changed, 59 insertions(+) create mode 100755 t/t9904-diff-relative-config.shconfig/diff.txt +0
-0
config/diff.txt diff.mnemonicPrefix:: · line 110
Quoted 6 lines
config/diff.txt +3
-0@@ -105,6 +105,10 @@ diff.mnemonicPrefix:: diff.noprefix:: If set, 'git diff' does not show any source or destination prefix. +diff.relative:: + If set to "true", 'git diff' does not show changes outside of the directory + and show pathnames relative.
This last part sounded stilted. Maybe "and shows pathnames relative to the current directory", assuming I've understood what it was meant to say (and possible the same change in the commit message)
Philip
Quoted 90 lines
config/diff.txt +1
-0+ diff.orderFile:: File indicating how to order files within a diff. See the '-O' option to linkgit:git-diff[1] for details.diff.c +7
-0@@ -48,6 +48,7 @@ static const char *diff_order_file_cfg;int diff_auto_refresh_index =1 ;static int diff_mnemonic_prefix;static int diff_no_prefix; +static int diff_relative;static int diff_stat_graph_width;static int diff_dirstat_permille_default =30 ;static struct diff_options default_diff_options;@@ -386,6 +387,10 @@ int git_diff_ui_config(const char *var, const char *value, void *cb) diff_no_prefix =git_config_bool (var, value);return 0 ; } +if (!strcmp (var,"diff.relative" )) { + diff_relative =git_config_bool (var, value); +return 0 ; + }if (!strcmp (var,"diff.statgraphwidth" )) { diff_stat_graph_width =git_config_int (var, value);return 0 ;@@ -4558,6 +4563,8 @@ void repo_diff_setup(struct repository *r, struct diff_options *options) options->b_prefix ="b/" ; } + options->flags.relative_name = diff_relative; + options->color_moved = diff_color_moved_default; options->color_moved_ws_handling = diff_color_moved_ws_default;t9904-diff-relative-config.sh new file +48
-0@@ -0,0 +1,48 @@ +#!/bin/sh + +test_description='config diff.relative' + +. ./test-lib.sh + +test_expect_success 'setup' ' + git commit --allow-empty -m empty && + echo content >file1 && + mkdir subdir && + echo other content >subdir/file2 && + git add . && + git commit -m one +' + +check_diff () { + dir=$1 + shift + expect=$1 + shift + relative_opt=$1 + shift + short_blob=$(git rev-parse --short "$(git hash-object subdir/file2)") + cat >expected <<-EOF + diff --git a/$expect b/$expect + new file mode 100644 + index 0000000..$short_blob + --- /dev/null + +++ b/$expect + @@ -0,0 +1 @@ + +other content + EOF + test_expect_success "-p $*" " + test_config -C $dir diff.relative $relative_opt && + git -C '$dir' diff -p $* HEAD^ >actual && + test_cmp expected actual + " +} + +check_diff . file2 false --relative=subdir/ +check_diff . file2 false --relative=subdir +check_diff . file2 true --relative=subdir/ +check_diff . file2 true --relative=subdir +check_diff subdir file2 false --relative +check_diff subdir file2 true --relative +check_diff subdir file2 true + +test_done
Hi Philip,
Quoted 8 lines · Philip Oakley
config/diff.txt diff.mnemonicPrefix:: · line 110
Quoted 3 lines · Laurent Arnoud
config/diff.txt +3
-0+diff.relative:: + If set to "true", 'git diff' does not show changes outside of the directory + and show pathnames relative.This last part sounded stilted. Maybe "and shows pathnames relative to the current directory", assuming I've understood what it was meant to say (and possible the same change in the commit message)
Yes that what it was meant by this, I will submit a patch with your suggestion
Cheers
Signature · 1 line
Laurent
Quoted 2 lines · Laurent Arnoud
The
diff.relativeboolean option set totrueto show only changes on the current directory and show relative pathnames.
Usually when we implement configuration settings like this, we implement an option value, such as --no-relative, so that users or scripting tools can disable this feature if they need to. However, I don't see that in this series. Would adding such a feature be possible?
Signature · 2 lines
brian m. carlson: Houston, Texas, US OpenPGP: https://keybase.io/bk2204
Quoted 8 lines · brian m. carlson
Quoted 2 lines · Laurent Arnoud
The
diff.relativeboolean option set totrueto show only changes on the current directory and show relative pathnames.Usually when we implement configuration settings like this, we implement an option value, such as --no-relative, so that users or scripting tools can disable this feature if they need to. However, I don't see that in this series. Would adding such a feature be possible?
I think I saw a variant that does have --[no-]foobar support on the list, but I may be hallucinating. You definitely would want it, or you've broken "format-patch" forever without a knob to countermand the configuration (well, you can still say "git -c diff.foobar=no" but that's kind of cheating).
Quoted 11 lines · Junio C Hamano
Quoted 8 lines · brian m. carlson
Quoted 2 lines · Laurent Arnoud
The
diff.relativeboolean option set totrueto show only changes on the current directory and show relative pathnames.Usually when we implement configuration settings like this, we implement an option value, such as --no-relative, so that users or scripting tools can disable this feature if they need to. However, I don't see that in this series. Would adding such a feature be possible?
Quoted 5 lines
I think I saw a variant that does have --[no-]foobar support on the list, but I may be hallucinating. You definitely would want it, or you've broken "format-patch" forever without a knob to countermand the configuration (well, you can still say "git -c diff.foobar=no" but that's kind of cheating).
Yes I've submitted a v2 patch with the --no-relative I will send a v3 to this thread for review
Signature · 1 line
Laurent
The diff.relative boolean option set to true show only changes on the current directory and show relative pathnames to the current directory.
Teach --no-relative to override earlier --relative
--- Documentation/config/diff.txt | 4 ++ Documentation/diff-options.txt | 2 + diff.c | 10 ++++ t/t9904-diff-relative-config.sh | 93 +++++++++++++++++++++++++++++++++ 4 files changed, 109 insertions(+) create mode 100755 t/t9904-diff-relative-config.sh
Documentation/config/diff.txt +4 -0
@@ -105,6 +105,10 @@ diff.mnemonicPrefix:: diff.noprefix:: If set, 'git diff' does not show any source or destination prefix. +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.orderFile:: File indicating how to order files within a diff. See the '-O' option to linkgit:git-diff[1] for details.
Documentation/diff-options.txt +2 -0
@@ -651,6 +651,8 @@ ifndef::git-format-patch[] not in a subdirectory (e.g. in a bare repository), you can name which subdirectory to make the output relative to by giving a <path> as an argument. +--no-relative:: + Turn off relative pathnames and include all changes in the repository. endif::git-format-patch[] -a::
diff.c +10 -0
@@ -48,6 +48,7 @@ static const char *diff_order_file_cfg;int diff_auto_refresh_index =1 ;static int diff_mnemonic_prefix;static int diff_no_prefix; +static int diff_relative;static int diff_stat_graph_width;static int diff_dirstat_permille_default =30 ;static struct diff_options default_diff_options;
@@ -386,6 +387,10 @@ int git_diff_ui_config(const char *var, const char *value, void *cb) diff_no_prefix =git_config_bool (var, value);return 0 ; } +if (!strcmp (var,"diff.relative" )) { + diff_relative =git_config_bool (var, value); +return 0 ; + }if (!strcmp (var,"diff.statgraphwidth" )) { diff_stat_graph_width =git_config_int (var, value);return 0 ;
@@ -4558,6 +4563,8 @@ void repo_diff_setup(struct repository *r, struct diff_options *options) options->b_prefix ="b/" ; } + options->flags.relative_name = diff_relative; + options->color_moved = diff_color_moved_default; options->color_moved_ws_handling = diff_color_moved_ws_default;
@@ -5494,6 +5501,9 @@ static void prep_parse_options(struct diff_options *options) N_("when run from subdir, exclude changes outside and show relative paths"), PARSE_OPT_NONEG | PARSE_OPT_OPTARG, diff_opt_relative), +OPT_SET_INT_F (0 ,"no-relative" , &options->flags.relative_name, +N_ ("disable diff.relative config option" ), +0 ,PARSE_OPT_NONEG ),OPT_BOOL ('a' ,"text" , &options->flags.text,N_ ("treat all files as text" )), OPT_BOOL('R', NULL, &options->flags.reverse_diff,
t/t9904-diff-relative-config.sh new file +93 -0
93 lines not on this page · raw message
--
2.26.2
Hi Laurent
Quoted 35 lines · Laurent Arnoud
The
diff.relativeboolean option set totrueshow only changes on the current directory and show relative pathnames to the current directory.Teach --no-relative to override earlier --relative
Signed-off-by Laurent Arnoud <[email protected]>--- Documentation/config/diff.txt | 4 ++ Documentation/diff-options.txt | 2 + diff.c | 10 ++++ t/t9904-diff-relative-config.sh | 93 +++++++++++++++++++++++++++++++++ 4 files changed, 109 insertions(+)create mode 100755
t/t9904-diff-relative-config.shDocumentation/config/diff.txt +4
-0@@ -105,6 +105,10 @@ diff.mnemonicPrefix:: diff.noprefix:: If set, 'git diff' does not show any source or destination prefix. +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.orderFile:: File indicating how to order files within a diff. See the '-O' option to linkgit:git-diff[1] for details.Documentation/diff-options.txt +0
-0
Documentation/diff-options.txt ifndef::git-format-patch[] · line 655
Quoted 5 lines
Documentation/diff-options.txt +2
-0@@ -651,6 +651,8 @@ ifndef::git-format-patch[] not in a subdirectory (e.g. in a bare repository), you can name which subdirectory to make the output relative to by giving a <path> as an argument. +--no-relative:: + Turn off relative pathnames and include all changes in the repository.
It might be helpful to mention that this is the default and this option exists to override the config setting
Quoted 36 lines
Documentation/diff-options.txt +0
-0endif::git-format-patch[] -a::diff.c +7
-0@@ -48,6 +48,7 @@ static const char *diff_order_file_cfg;int diff_auto_refresh_index =1 ;static int diff_mnemonic_prefix;static int diff_no_prefix; +static int diff_relative;static int diff_stat_graph_width;static int diff_dirstat_permille_default =30 ;static struct diff_options default_diff_options;@@ -386,6 +387,10 @@ int git_diff_ui_config(const char *var, const char *value, void *cb) diff_no_prefix =git_config_bool (var, value);return 0 ; } +if (!strcmp (var,"diff.relative" )) { + diff_relative =git_config_bool (var, value); +return 0 ; + }if (!strcmp (var,"diff.statgraphwidth" )) { diff_stat_graph_width =git_config_int (var, value);return 0 ;@@ -4558,6 +4563,8 @@ void repo_diff_setup(struct repository *r, struct diff_options *options) options->b_prefix ="b/" ; } + options->flags.relative_name = diff_relative; + options->color_moved = diff_color_moved_default; options->color_moved_ws_handling = diff_color_moved_ws_default;
diff.c static void prep_parse_options(struct diff_options *options) · line 5506
Quoted 6 lines
diff.c +3
-0@@ -5494,6 +5501,9 @@ static void prep_parse_options(struct diff_options *options) N_("when run from subdir, exclude changes outside and show relative paths"), PARSE_OPT_NONEG | PARSE_OPT_OPTARG, diff_opt_relative), +OPT_SET_INT_F (0 ,"no-relative" , &options->flags.relative_name, +N_ ("disable diff.relative config option" ), + 0, PARSE_OPT_NONEG),
Rather than adding a new option, it would be better to modify the existing --relative option. If you remove PARSE_OPT_NONEG from the declaration above it will support --no-relative. You will also need to modify diff_opt_relative() to handle clearing the option.
Best Wishes
Phillip
Quoted 105 lines
diff.c +0
-0OPT_BOOL ('a' ,"text" , &options->flags.text,N_ ("treat all files as text" )), OPT_BOOL('R', NULL, &options->flags.reverse_diff,t/t9904-diff-relative-config.sh new file +93
-1@@ -0,0 +1,93 @@ +#!/bin/sh + +test_description='config diff.relative' + +. ./test-lib.sh + +test_expect_success 'setup' ' + git commit --allow-empty -m empty && + echo content >file1 && + mkdir subdir && + echo other content >subdir/file2 && + git add . && + git commit -m one +' + +check_diff_relative () { + dir=$1 + shift + expect=$1 + shift + relative_opt=$1 + shift + short_blob=$(git rev-parse --short "$(git hash-object subdir/file2)") + cat >expected <<-EOF + diff --git a/$expect b/$expect + new file mode 100644 + index 0000000..$short_blob + --- /dev/null + +++ b/$expect + @@ -0,0 +1 @@ + +other content + EOF + test_expect_success "config.relative $relative_opt -p $*" " + test_config -C $dir diff.relative $relative_opt && + git -C '$dir' diff -p $* HEAD^ >actual && + test_cmp expected actual + " +} + +check_diff_no_relative () { + dir=$1 + shift + expect=$1 + shift + relative_opt=$1 + shift + short_blob_file1=$(git rev-parse --short "$(git hash-object file1)") + short_blob_file2=$(git rev-parse --short "$(git hash-object subdir/file2)") + cat >expected <<-EOF + diff --git a/file1 b/file1 + new file mode 100644 + index 0000000..$short_blob_file1 + --- /dev/null + +++ b/file1 + @@ -0,0 +1 @@ + +content + diff --git a/$expect b/$expect + new file mode 100644 + index 0000000..$short_blob_file2 + --- /dev/null + +++ b/$expect + @@ -0,0 +1 @@ + +other content + EOF + cat expected + test_expect_success "config.relative $relative_opt -p $*" " + test_config -C $dir diff.relative $relative_opt && + git -C '$dir' diff -p $* HEAD^ >actual && + git -C '$dir' diff -p $* HEAD^ >/tmp/actual && + test_cmp expected actual + " +} + +check_diff_relative . file2 false --relative=subdir/ +check_diff_relative . file2 false --relative=subdir +check_diff_relative . file2 true --relative=subdir/ +check_diff_relative . file2 true --relative=subdir +check_diff_relative subdir file2 false --relative +check_diff_relative subdir file2 true --relative +check_diff_relative subdir file2 true +check_diff_relative subdir file2 false --no-relative --relative +check_diff_relative subdir file2 true --no-relative --relative +check_diff_relative . file2 false --no-relative --relative=subdir +check_diff_relative . file2 true --no-relative --relative=subdir + +check_diff_no_relative . subdir/file2 false +check_diff_no_relative . subdir/file2 true --no-relative +check_diff_no_relative . subdir/file2 false --no-relative +check_diff_no_relative subdir subdir/file2 false +check_diff_no_relative subdir subdir/file2 true --no-relative +check_diff_no_relative subdir subdir/file2 false --no-relative + +test_done --2.26.2
The diff.relative boolean option set to true show only changes on the current directory and show relative pathnames to the current directory.
Teach --no-relative to override earlier --relative
--- Documentation/config/diff.txt | 4 ++ Documentation/diff-options.txt | 3 ++ diff.c | 16 ++++-- t/t9904-diff-relative-config.sh | 93 +++++++++++++++++++++++++++++++++ 4 files changed, 113 insertions(+), 3 deletions(-) create mode 100755 t/t9904-diff-relative-config.sh
Documentation/config/diff.txt +4 -0
@@ -105,6 +105,10 @@ diff.mnemonicPrefix:: diff.noprefix:: If set, 'git diff' does not show any source or destination prefix. +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.orderFile:: File indicating how to order files within a diff. See the '-O' option to linkgit:git-diff[1] for details.
Documentation/diff-options.txt +3 -0
@@ -651,6 +651,9 @@ ifndef::git-format-patch[] not in a subdirectory (e.g. in a bare repository), you can name which subdirectory to make the output relative to by giving a <path> as an argument. +--no-relative:: + Turn off relative pathnames and include all changes in the repository. + This can be used to override configuration settings `diff.relative`. endif::git-format-patch[] -a::
diff.c +13 -3
@@ -48,6 +48,7 @@ static const char *diff_order_file_cfg;int diff_auto_refresh_index =1 ;static int diff_mnemonic_prefix;static int diff_no_prefix; +static int diff_relative;static int diff_stat_graph_width;static int diff_dirstat_permille_default =30 ;static struct diff_options default_diff_options;
@@ -386,6 +387,10 @@ int git_diff_ui_config(const char *var, const char *value, void *cb) diff_no_prefix =git_config_bool (var, value);return 0 ; } +if (!strcmp (var,"diff.relative" )) { + diff_relative =git_config_bool (var, value); +return 0 ; + }if (!strcmp (var,"diff.statgraphwidth" )) { diff_stat_graph_width =git_config_int (var, value);return 0 ;
@@ -4558,6 +4563,8 @@ void repo_diff_setup(struct repository *r, struct diff_options *options) options->b_prefix ="b/" ; } + options->flags.relative_name = diff_relative; + options->color_moved = diff_color_moved_default; options->color_moved_ws_handling = diff_color_moved_ws_default;
@@ -5195,8 +5202,11 @@ static int diff_opt_relative(const struct option *opt, {struct diff_options *options = opt->value; -BUG_ON_OPT_NEG (unset); - options->flags.relative_name =1 ; +if (unset) { + options->flags.relative_name =0 ; + }else { + options->flags.relative_name =1 ; + }if (arg) options->prefix = arg;return 0 ;
@@ -5492,7 +5502,7 @@ static void prep_parse_options(struct diff_options *options)OPT_GROUP (N_ ("Other diff options" )),OPT_CALLBACK_F (0 ,"relative" , options,N_ ("<prefix>" ),N_ ("when run from subdir, exclude changes outside and show relative paths" ), -PARSE_OPT_NONEG |PARSE_OPT_OPTARG , +PARSE_OPT_OPTARG , diff_opt_relative),OPT_BOOL ('a' ,"text" , &options->flags.text, N_("treat all files as text")),
t/t9904-diff-relative-config.sh new file +93 -0
93 lines not on this page · raw message
--
2.26.2
Hi Laurent,
Quoted 1 line · Laurent Arnoud
Subject: Re: [PATCH v4] diff: add config option relative
I think the subject should be changed to.
diff: allow overriding --relative
Quoted 4 lines
The
diff.relativeboolean option set totrueshow only changes on the current directory and show relative pathnames to the current directory.
Quoted 8 lines
Teach --no-relative to override earlier --relative
Signed-off-by Laurent Arnoud <[email protected]>--- Documentation/config/diff.txt | 4 ++ Documentation/diff-options.txt | 3 ++ diff.c | 16 ++++-- t/t9904-diff-relative-config.sh | 93 +++++++++++++++++++++++++++++++++
I think t99?? is used for miscellaneous tests.
To me, diff-relative things should be tested in t4045-diff-relative.sh
Documentation/config/diff.txt diff.mnemonicPrefix:: · line 109
Quoted 13 lines
4 files changed, 113 insertions(+), 3 deletions(-) create mode 100755 t/t9904-diff-relative-config.shDocumentation/config/diff.txt +2
-0@@ -105,6 +105,10 @@ diff.mnemonicPrefix:: diff.noprefix:: If set, 'git diff' does not show any source or destination prefix. +diff.relative:: + If set to "true", 'git diff' does not show changes outside of the directory
I think it's better to change "true" to either:
'true' (generated to <em>true</em>, ortrue generated to <code>true<code>
Not sure which one is prefered, though.
This file uses both 2 styles.
I _think_ true is preferred.
Quoted 10 lines
Documentation/config/diff.txt +2
-0+ and show pathnames relative to the current directory. + diff.orderFile:: File indicating how to order files within a diff. See the '-O' option to linkgit:git-diff[1] for details.Documentation/diff-options.txt +0
-0
Documentation/diff-options.txt ifndef::git-format-patch[] · line 654
Quoted 4 lines
Documentation/diff-options.txt +1
-0@@ -651,6 +651,9 @@ ifndef::git-format-patch[] not in a subdirectory (e.g. in a bare repository), you can name which subdirectory to make the output relative to by giving a <path> as an argument. +--no-relative::
Please merge this option with --relative[=<path>] above. And says something likes:
--no-relative can be used to countermand both diff.relative and previous --relative
Documentation/diff-options.txt static int diff_opt_relative(const struct option *opt, · line 5209
Quoted 11 lines
Documentation/diff-options.txt +5
-2@@ -5195,8 +5202,11 @@ static int diff_opt_relative(const struct option *opt, { struct diff_options *options = opt->value; - BUG_ON_OPT_NEG(unset); - options->flags.relative_name = 1; + if (unset) { + options->flags.relative_name = 0; + } else { + options->flags.relative_name = 1; + }
Can this block be simplified as:
options->flags.relative_name = !unset;
Documentation/diff-options.txt static int diff_opt_relative(const struct option *opt,
Quoted 8 lines
Documentation/diff-options.txt +8
-0+check_diff_relative () { + dir=$1 + shift + expect=$1 + shift + relative_opt=$1 + shift + short_blob=$(git rev-parse --short "$(git hash-object subdir/file2)")
I think current practice want to have git hash-object as separated. And all git-related code moved inside test_expect*
t/t9904-diff-relative-config.sh +12 -11
@@ -20,17 +20,18 @@ check_diff_relative () { shift relative_opt=$1 shift - short_blob=$(git rev-parse --short "$(git hash-object subdir/file2)") - cat >expected <<-EOF - diff --git a/$expect b/$expect - new file mode 100644 - index 0000000..$short_blob - --- /dev/null - +++ b/$expect - @@ -0,0 +1 @@ - +other content - EOF - test_expect_success "config.relative $relative_opt -p $*" " + test_expect_success "config.relative $relative_opt -p $* in $dir" " + hash=\$(git hash-object subdir/file2) && + short_blob=\$(git rev-parse --short \$hash) && + cat >expected <<-EOF && + diff --git a/$expect b/$expect + new file mode 100644 + index 0000000..\$short_blob + --- /dev/null + +++ b/$expect + @@ -0,0 +1 @@ + +other content + EOF test_config -C $dir diff.relative $relative_opt && git -C '$dir' diff -p $* HEAD^ >actual && test_cmp expected actual
Quoted 9 lines
Documentation/diff-options.txt +9
-0+ short_blob_file1=$(git rev-parse --short "$(git hash-object file1)") + short_blob_file2=$(git rev-parse --short "$(git hash-object subdir/file2)") + cat >expected <<-EOF + diff --git a/file1 b/file1 + new file mode 100644 + index 0000000..$short_blob_file1 + --- /dev/null + +++ b/file1 + @@ -0,0 +1 @@
Documentation/diff-options.txt
Quoted 10 lines
Documentation/diff-options.txt +10
-0+ +content + diff --git a/$expect b/$expect + new file mode 100644 + index 0000000..$short_blob_file2 + --- /dev/null + +++ b/$expect + @@ -0,0 +1 @@ + +other content + EOF + cat expected
Above comment also applied here.
And remove this debug cat.
Signature · 1 line
Danh
Quoted 12 lines · Đoàn Trần Công Danh
Hi Laurent,
Quoted 2 lines · Laurent Arnoud
Subject: Re: [PATCH v4] diff: add config option relative
I think the subject should be changed to.
diff: allow overriding --relative
I feel stupid about this now.
Please disregard my comment about subject.
Quoted 8 lines · Đoàn Trần Công Danh
Quoted 4 lines
Documentation/config/diff.txt | 4 ++ Documentation/diff-options.txt | 3 ++ diff.c | 16 ++++-- t/t9904-diff-relative-config.sh | 93 +++++++++++++++++++++++++++++++++I think t99?? is used for miscellaneous tests.
To me, diff-relative things should be tested in
t4045-diff-relative.sh
Right. Thanks for carefully checking what we already have.
Quoted 13 lines
Documentation/diff-options.txt ifndef::git-format-patch[] · line 654
Quoted 9 lines
Documentation/diff-options.txt +1
-0@@ -651,6 +651,9 @@ ifndef::git-format-patch[] not in a subdirectory (e.g. in a bare repository), you can name which subdirectory to make the output relative to by giving a <path> as an argument. +--no-relative::Please merge this option with
--relative[=<path>]above. And says something likes:
Quoted 2 lines
--no-relativecan be used to countermand bothdiff.relativeand previous--relative
This, and all the rest of comments are quite good. Thanks for helping.
The diff.relative boolean option set to true show only changes on the current directory and show relative pathnames to the current directory.
Teach --no-relative to override earlier --relative
--- Documentation/config/diff.txt | 4 ++ Documentation/diff-options.txt | 2 + diff.c | 12 +++-- t/t4045-diff-relative.sh | 83 ++++++++++++++++++++++++++++++++-- 4 files changed, 95 insertions(+), 6 deletions(-)
Documentation/config/diff.txt +4 -0
@@ -105,6 +105,10 @@ diff.mnemonicPrefix:: diff.noprefix:: If set, 'git diff' does not show any source or destination prefix. +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.orderFile:: File indicating how to order files within a diff. See the '-O' option to linkgit:git-diff[1] for details.
Documentation/diff-options.txt +2 -0
@@ -651,6 +651,8 @@ ifndef::git-format-patch[] not in a subdirectory (e.g. in a bare repository), you can name which subdirectory to make the output relative to by giving a <path> as an argument. + `--no-relative` can be used to countermand both `diff.relative` config + option and previous `--relative`. endif::git-format-patch[] -a::
diff.c +9 -3
@@ -48,6 +48,7 @@ static const char *diff_order_file_cfg;int diff_auto_refresh_index =1 ;static int diff_mnemonic_prefix;static int diff_no_prefix; +static int diff_relative;static int diff_stat_graph_width;static int diff_dirstat_permille_default =30 ;static struct diff_options default_diff_options;
@@ -386,6 +387,10 @@ int git_diff_ui_config(const char *var, const char *value, void *cb) diff_no_prefix =git_config_bool (var, value);return 0 ; } +if (!strcmp (var,"diff.relative" )) { + diff_relative =git_config_bool (var, value); +return 0 ; + }if (!strcmp (var,"diff.statgraphwidth" )) { diff_stat_graph_width =git_config_int (var, value);return 0 ;
@@ -4558,6 +4563,8 @@ void repo_diff_setup(struct repository *r, struct diff_options *options) options->b_prefix ="b/" ; } + options->flags.relative_name = diff_relative; + options->color_moved = diff_color_moved_default; options->color_moved_ws_handling = diff_color_moved_ws_default;
@@ -5195,8 +5202,7 @@ static int diff_opt_relative(const struct option *opt, {struct diff_options *options = opt->value; -BUG_ON_OPT_NEG (unset); - options->flags.relative_name =1 ; + options->flags.relative_name = !unset;if (arg) options->prefix = arg;return 0 ;
@@ -5492,7 +5498,7 @@ static void prep_parse_options(struct diff_options *options)OPT_GROUP (N_ ("Other diff options" )),OPT_CALLBACK_F (0 ,"relative" , options,N_ ("<prefix>" ),N_ ("when run from subdir, exclude changes outside and show relative paths" ), -PARSE_OPT_NONEG |PARSE_OPT_OPTARG , +PARSE_OPT_OPTARG , diff_opt_relative),OPT_BOOL ('a' ,"text" , &options->flags.text, N_("treat all files as text")),
t/t4045-diff-relative.sh +80 -3
105 lines not on this page · raw message
--
2.26.2
Hello Laurent,
I have not worked in this part of Git before, please pardon my ignorance. I went through the conversations held in this thread Here are my inferences:
Quoted 5 lines
The
diff.relativeboolean option set totrueshow only changes on the current directory and show relative pathnames to the current directory.Teach --no-relative to override earlier --relative
I think the message can be written better, maybe something like:
The diff.relative boolean option set to true shows only changes in the current directory/value specified by the path argument of the relative option and shows pathnames relative to the aforementioned directory.
Teach --no-relative to override the earlier --relative
Documentation/config/diff.txt diff.mnemonicPrefix:: · line 110
Quoted 9 lines
Documentation/config/diff.txt +3
-0@@ -105,6 +105,10 @@ diff.mnemonicPrefix:: diff.noprefix:: If set, 'git diff' does not show any source or destination prefix. +diff.relative:: + If set to 'true', 'git diff' does not show changes outside of the directory + and show pathnames relative to the current directory.
In the second last line, it would be better to write is as:
... does not show changes outside of the current directory/the path provided as the argument in relative?
Even my version of the above line seems very crude and innaccurate, but I think that we should take into account the path passed down to us by the --relative[=<path>] option.
Moving on, what I wondered was that maybe making it a true/false option would be better? Something like:
git diff --relative=false //override the diff.relative setting
git diff --relative=true <path> //works like the usual `relative`And by the usual, I mean :
git diff --relative[=<path>]
What do you think? I think it would be better than adding a new option.
Also, if I am not mistaken:
Documentation/config/diff.txt static int diff_opt_relative(const struct option *opt, · line 5205
Quoted 7 lines
Documentation/config/diff.txt +1
-2@@ -5195,8 +5202,7 @@ static int diff_opt_relative(const struct option *opt, { struct diff_options *options = opt->value; - BUG_ON_OPT_NEG(unset); - options->flags.relative_name = 1; + options->flags.relative_name = !unset;
This is the overriding part right?
BTW you mention the no-relative setting which will override the relative option. I am not able to see where exactly is the occurence of the no-relative option in the code? What I mean is that I am not able to observe where exactly does the C code identify a no-relative option from the command line input? Did I miss something out here?
All nits aside, it looks like a very good concept to me. Nice work! :)
Regards,
Shourya Shukla
Hi Shourya,
Quoted 5 lines · Shourya Shukla
BTW you mention the
no-relativesetting which will override therelativeoption. I am not able to see where exactly is the occurence of theno-relativeoption in the code? What I mean is that I am not able to observe where exactly does the C code identify ano-relativeoption from the command line input? Did I miss something out here?
--no-relative is parsed by removing PARSE_OPT_NONE in prep_parse_options (diff.c:5495)
Signature · 1 line
Danh
Hi Shourya,
Quoted 8 lines · Shourya Shukla
I think the message can be written better, maybe something like:
The
diff.relativeboolean option set totrueshows only changes in the current directory/value specified by thepathargument of therelativeoption and shows pathnames relative to the aforementioned directory.Teach
--no-relativeto override the earlier--relative
Thanks I've applied your suggestion to the v6 patch
Quoted 22 lines
Documentation/config/diff.txt diff.mnemonicPrefix:: · line 110
Quoted 9 lines
Documentation/config/diff.txt +3
-0@@ -105,6 +105,10 @@ diff.mnemonicPrefix:: diff.noprefix:: If set, 'git diff' does not show any source or destination prefix. +diff.relative:: + If set to 'true', 'git diff' does not show changes outside of the directory + and show pathnames relative to the current directory.In the second last line, it would be better to write is as:
... does not show changes outside of the current directory/the path provided as the argument in
relative?Even my version of the above line seems very crude and innaccurate, but I think that we should take into account the
pathpassed down to us by the--relative[=<path>]option.Moving on, what I wondered was that maybe making it a
true/falseoption would be better? Something like:
Quoted 7 lines
git diff --relative=false //override the diff.relative setting git diff --relative=true <path> //works like the usual `relative`And by the usual, I mean :
git diff --relative[=<path>]What do you think? I think it would be better than adding a new option.
I think this would be complicated to check if true/false is a directory of not; it has been mentioned by Junio on another thread for a patch alike
Cheers
Signature · 1 line
Laurent
Hi Laurent,
Quoted 7 lines · Laurent Arnoud
The
diff.relativeboolean option set totrueshow only changes on the current directory and show relative pathnames to the current directory.Teach --no-relative to override earlier --relative
Signed-off-by Laurent Arnoud <[email protected]>
Thanks for addressing my comment.
Sorry for detecting this late.
Since I usually only look into end of mail-archive to see any interesting topic.
And sorry for this late email,
I want to run full test before replying with this.
I've just seen this:
https://lore.kernel.org/git/[email protected]/
I've written some test and concluded that we'll need this fix-up to make sure git-format-patch(1) doesn't generate broken patch:
----------------8<----------------
builtin/log.c | 1 + t/t4045-diff-relative.sh | 11 ++++++++--- 2 files changed, 9 insertions(+), 3 deletions(-)
builtin/log.c +1 -0
@@ -1744,6 +1744,7 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix) rev.diff =1 ; rev.max_parents =1 ; rev.diffopt.flags.recursive =1 ; + rev.diffopt.flags.relative_name =0 ; rev.subject_prefix = fmt_patch_subject_prefix;memset (&s_r_opt,0 ,sizeof (s_r_opt)); s_r_opt.def ="HEAD" ;
t/t4045-diff-relative.sh +8 -4
@@ -11,7 +11,8 @@ test_expect_success 'setup' ' blob_file1=$(git hash-object file1) && blob_file2=$(git hash-object subdir/file2) && git add . && - git commit -m one + git commit -m one && + git format-patch -1 --stdout >expect.patch ' check_diff () {
@@ -107,7 +108,9 @@ check_diff_relative_option () { test_expect_success "config diff.relative $relative_opt -p $*" " test_config -C $dir diff.relative $relative_opt && git -C '$dir' diff -p $* HEAD^ >actual && - test_cmp expected actual + test_cmp expected actual && + git -C '$dir' format-patch -1 --stdout >actual.patch && + test_cmp expect.patch actual.patch " }
@@ -140,7 +143,9 @@ check_diff_no_relative_option () { test_config -C $dir diff.relative $relative_opt && git -C '$dir' diff -p $* HEAD^ >actual && git -C '$dir' diff -p $* HEAD^ >/tmp/actual && - test_cmp expected actual + test_cmp expected actual && + git -C '$dir' format-patch -1 --stdout >actual.patch && + test_cmp expect.patch actual.patch " } --------------------8<-------------------------
Review void repo_diff_setup(struct repository *r, struct diff_options *options) · line 4567
Quoted 6 lines
(quoted diff) +2
-0@@ -4558,6 +4563,8 @@ void repo_diff_setup(struct repository *r, struct diff_options *options) options->b_prefix = "b/"; } + options->flags.relative_name = diff_relative; +
Nitpick:
I don't think this option is too special to add a newline to separate it from the rest :)
Sorry about not seeing this earlier, I'm a very careless person.
Anyway, I think (just a matter of my _personal_ preference), it's better to move it up 21 lines, together with:
options->flags.rename_empty = 1;
t/t4045-diff-relative.sh test_expect_success 'setup' ' · line 12
Quoted 11 lines
t/t4045-diff-relative.sh +2
-1@@ -8,7 +8,8 @@ test_expect_success 'setup' ' echo content >file1 && mkdir subdir && echo other content >subdir/file2 && - blob=$(git hash-object subdir/file2) && + blob_file1=$(git hash-object file1) && + blob_file2=$(git hash-object subdir/file2) &&
This rename from blob to blob_file2 is a noise to this patch. Not sure if we should make a preparatory patch to rename, though.
*I* would say yes, and another patch to move all git-related code into test_expect_* family. Then, all new testing code for git in this patch should be placed inside test_expect_*, too.
I think it's better to wait for other's opinions :)
Quoted 6 lines
t/t4045-diff-relative.sh +2
-0@@ -86,4 +87,80 @@ do check_$type . dir/file2 --relative=sub done + diff --git a/$expect b/$expect + new file mode 100644
t/t4045-diff-relative.sh do · line 101
Quoted 10 lines
t/t4045-diff-relative.sh +10
-0+ index 0000000..$short_blob_file2 + --- /dev/null + +++ b/$expect + @@ -0,0 +1 @@ + +other content + EOF + test_expect_success "config diff.relative $relative_opt -p $*" " + test_config -C $dir diff.relative $relative_opt && + git -C '$dir' diff -p $* HEAD^ >actual && + git -C '$dir' diff -p $* HEAD^ >/tmp/actual &&
Please this leftover from debugging.
Signature · 1 line
Danh
Quoted 13 lines · Đoàn Trần Công Danh
I've written some test and concluded that we'll need this fix-up to make sure git-format-patch(1) doesn't generate broken patch:
----------------8<----------------
builtin/log.c | 1 + t/t4045-diff-relative.sh | 11 ++++++++--- 2 files changed, 9 insertions(+), 3 deletions(-)builtin/log.c +0
-0
builtin/log.c int cmd_format_patch(int argc, const char **argv, const char *prefix) · line 1750
Quoted 7 lines
builtin/log.c +1
-0@@ -1744,6 +1744,7 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix) rev.diff =1 ; rev.max_parents =1 ; rev.diffopt.flags.recursive =1 ; + rev.diffopt.flags.relative_name =0 ; rev.subject_prefix = fmt_patch_subject_prefix;memset (&s_r_opt,0 ,sizeof (s_r_opt)); s_r_opt.def ="HEAD" ;
Hmph, what do you exactly mean by "broken patch"?
I actually do not mind people who set "diff.relative" to do
$ git config diff.relative true
$ cd t && git format-patch -1 --stdoutto get an incomplete patch that covers only the t/ subdirectory, as long as they can ask Git to optionally get the full view with
$ cd t && git format-patch -1 --stdout --no-relative
Note: this is not limited to format-patch but all the commands in the diff family like "log --stat", "show", etc.
Of course, diff.relative configuration would have no use for me personally and I suspect it would be useless for many people, but those who work inside a deeply nested project (java perhaps?) it would be handy and it makes sense to match the default behaviour between "diff", "show" and "format-patch" when the configuration is active, as long as they have a way to contermand from the command line.
Quoted 11 lines · Junio C Hamano
Hmph, what do you exactly mean by "broken patch"?
I actually do not mind people who set "diff.relative" to do
$ git config diff.relative true $ cd t && git format-patch -1 --stdoutto get an incomplete patch that covers only the t/ subdirectory, as long as they can ask Git to optionally get the full view with
$ cd t && git format-patch -1 --stdout --no-relative
Well, git-format-patch has never understood --relative, which I think is a sane behaviour,
hence git-format-patch will never understand --no-relative after this patch.
Oh no, to my surprise, git-format-patch does accept --[no-]relative, now.
We don't document --relative for git-format-patch, the --relative documentation is placed under the guard, for that matter:
Documentation/diff-options.txt
ifndef::git-format-patch[]
-R::
Swap two inputs; that is, show differences from index or on-disk file to tree contents.
--relative[=<path>]::
When run from a subdirectory of the project, it can be told to exclude changes outside the directory and show pathnames relative to it with this option. When you are not in a subdirectory (e.g. in a bare repository), you can name which subdirectory to make the output relative to by giving a <path> as an argument.
endif::git-format-patch[]
Maybe time to fix the documentation.
Signature · 1 line
Danh
Quoted 2 lines · Đoàn Trần Công Danh
We don't document --relative for git-format-patch, the --relative documentation is placed under the guard, for that matter:
Yup, since it does not make much sense or "diff.relative" for that matter in the context of the "format-patch". In the same sense, -R makes little sense, so sane people would not want to read about the option in the documentation, I would think.
Quoted 8 lines
ifndef::git-format-patch[]
-R::
Swap two inputs; that is, show differences from index or on-disk file to tree contents.--relative[=<path>]::
When run from a subdirectory of the project, it can be told to exclude changes outside the directory and show
Quoted 9 lines · Junio C Hamano
Quoted 2 lines · Đoàn Trần Công Danh
We don't document --relative for git-format-patch, the --relative documentation is placed under the guard, for that matter:
Yup, since it does not make much sense or "diff.relative" for that matter in the context of the "format-patch". In the same sense, -R makes little sense, so sane people would not want to read about the option in the documentation, I would think.
Sane people wouldn't want to read that document when we don't have the config for diff.relative
But, now, we have. Let's document --no-relative, specifically for git-format-patch(1).
Perhaps something like this (maybe just fixing up to Laurent's) -----------------8<--------------
From: =?UTF-8?q?=C4=90o=C3=A0n=20Tr=E1=BA=A7n=20C=C3=B4ng=20Danh?=
<[email protected]>
Date: Tue, 19 May 2020 07:24:48 +0700
Subject: [PATCH] Documentation: document --no-relative for format-patch
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
git-format-patch(1) accepts --relative for a long time, but the generated patch couldn't be applied without accompanying information.
Hence, we've never document --relative for git-format-patch(1).
Now, we've introduced diff.relative config, let's tell Git's users that they have an option to override it.
--- Documentation/diff-options.txt | 5 +++++ 1 file changed, 5 insertions(+)
Documentation/diff-options.txt +5 -0
@@ -654,6 +654,11 @@ ifndef::git-format-patch[] `--no-relative` can be used to countermand both `diff.relative` config option and previous `--relative`. endif::git-format-patch[] +ifdef::git-format-patch[] +--no-relative:: + Countermand `diff.relative` config. Show all changes in the repository + with pathname relative to top-level directory of the repository. +endif::git-format-patch[] -a:: --text::
Signature · 1 line
Danh
Quoted 7 lines · Đoàn Trần Công Danh
Sane people wouldn't want to read that document when we don't have the config for diff.relative
But, now, we have. Let's document --no-relative, specifically for git-format-patch(1).
Perhaps something like this (maybe just fixing up to Laurent's)
I love it when a contributor pushes back with a well thought out counter-argument. Yes, I think the reasoning along the line makes sense.
If a project binds another project with -Xsubtree=<path>, a change to that part would be a good candidate to use "format-patch" with the "--relative=<path>". We didn't consider it a use case that is interesting enough, but it may be, which gives another reason why documenting "--[no-]relative[=<path>]" for the command may not be a bad thing, not just for the purpose of defeating "diff.relative".
For that reason, it may even make sense to use the same text for --no-relative and --relative[=<path>] we use for other commands in the diff family, i.e. leaving only -R inside the ifndef block.
Thanks.
Quoted 38 lines
-----------------8<--------------
From: =?UTF-8?q?=C4=90o=C3=A0n=20Tr=E1=BA=A7n=20C=C3=B4ng=20Danh?=
<[email protected]>
Date: Tue, 19 May 2020 07:24:48 +0700
Subject: [PATCH] Documentation: document --no-relative for format-patch
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bitgit-format-patch(1) accepts --relative for a long time, but the generated patch couldn't be applied without accompanying information.
Hence, we've never document --relative for git-format-patch(1).
Now, we've introduced
diff.relativeconfig, let's tell Git's users that they have an option to override it.Signed-off-by Đoàn Trần Công Danh <[email protected]>--- Documentation/diff-options.txt | 5 +++++ 1 file changed, 5 insertions(+)Documentation/diff-options.txt +5
-0@@ -654,6 +654,11 @@ ifndef::git-format-patch[] `--no-relative` can be used to countermand both `diff.relative` config option and previous `--relative`. endif::git-format-patch[] +ifdef::git-format-patch[] +--no-relative:: + Countermand `diff.relative` config. Show all changes in the repository + with pathname relative to top-level directory of the repository. +endif::git-format-patch[] -a:: --text::
PATCH v7 1/1 diff: add config option relative
The diff.relative boolean option set to true shows only changes in the current directory/value specified by the path argument of the relative option and shows pathnames relative to the aforementioned directory.
Teach --no-relative to override earlier --relative
Add for git-format-patch(1) options documentation --relative and --no-relative
--- Documentation/config/diff.txt | 4 ++ Documentation/diff-options.txt | 5 ++- diff.c | 11 +++-- t/t4014-format-patch.sh | 13 ++++++ t/t4045-diff-relative.sh | 82 ++++++++++++++++++++++++++++++++-- 5 files changed, 108 insertions(+), 7 deletions(-)
Documentation/config/diff.txt +4 -0
@@ -105,6 +105,10 @@ diff.mnemonicPrefix:: diff.noprefix:: If set, 'git diff' does not show any source or destination prefix. +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.orderFile:: File indicating how to order files within a diff. See the '-O' option to linkgit:git-diff[1] for details.
Documentation/diff-options.txt +4 -1
@@ -643,15 +643,18 @@ ifndef::git-format-patch[] -R:: Swap two inputs; that is, show differences from index or on-disk file to tree contents. +endif::git-format-patch[] --relative[=<path>]:: +--no-relative:: When run from a subdirectory of the project, it can be told to exclude changes outside the directory and show pathnames relative to it with this option. When you are not in a subdirectory (e.g. in a bare repository), you can name which subdirectory to make the output relative to by giving a <path> as an argument. -endif::git-format-patch[] + `--no-relative` can be used to countermand both `diff.relative` config + option and previous `--relative`. -a:: --text::
diff.c +8 -3
@@ -48,6 +48,7 @@ static const char *diff_order_file_cfg;int diff_auto_refresh_index =1 ;static int diff_mnemonic_prefix;static int diff_no_prefix; +static int diff_relative;static int diff_stat_graph_width;static int diff_dirstat_permille_default =30 ;static struct diff_options default_diff_options;
@@ -386,6 +387,10 @@ int git_diff_ui_config(const char *var, const char *value, void *cb) diff_no_prefix =git_config_bool (var, value);return 0 ; } +if (!strcmp (var,"diff.relative" )) { + diff_relative =git_config_bool (var, value); +return 0 ; + }if (!strcmp (var,"diff.statgraphwidth" )) { diff_stat_graph_width =git_config_int (var, value);return 0 ;
@@ -4538,6 +4543,7 @@ void repo_diff_setup(struct repository *r, struct diff_options *options) options->interhunkcontext = diff_interhunk_context_default; options->ws_error_highlight = ws_error_highlight_default; options->flags.rename_empty =1 ; + options->flags.relative_name = diff_relative; options->objfind =NULL ;/* pathchange left =NULL by default */
@@ -5195,8 +5201,7 @@ static int diff_opt_relative(const struct option *opt, {struct diff_options *options = opt->value; -BUG_ON_OPT_NEG (unset); - options->flags.relative_name =1 ; + options->flags.relative_name = !unset;if (arg) options->prefix = arg;return 0 ;
@@ -5492,7 +5497,7 @@ static void prep_parse_options(struct diff_options *options)OPT_GROUP (N_ ("Other diff options" )),OPT_CALLBACK_F (0 ,"relative" , options,N_ ("<prefix>" ),N_ ("when run from subdir, exclude changes outside and show relative paths" ), -PARSE_OPT_NONEG |PARSE_OPT_OPTARG , +PARSE_OPT_OPTARG , diff_opt_relative),OPT_BOOL ('a' ,"text" , &options->flags.text, N_("treat all files as text")),
t/t4014-format-patch.sh +13 -0
@@ -1602,6 +1602,19 @@ test_expect_success 'format patch ignores color.ui' ' test_cmp expect actual ' +test_expect_success 'format patch respects diff.relative' ' + rm -rf subdir && + mkdir subdir && + echo other content >subdir/file2 && + git add subdir/file2 && + git commit -F msg && + test_unconfig diff.relative && + git format-patch --relative=subdir --stdout -1 >expect && + test_config diff.relative true && + git -C subdir format-patch --stdout -1 >actual && + test_cmp expect actual +' + test_expect_success 'cover letter with invalid --cover-from-description and config' ' test_config branch.rebuild-1.description "config subject
t/t4045-diff-relative.sh +79 -3
104 lines not on this page · raw message
--
2.26.2
t/t4045-diff-relative.sh do · line 98
Quoted 10 lines · Laurent Arnoud
t/t4045-diff-relative.sh +9
-0+check_diff_relative_option () { + dir=$1 + shift + expect=$1 + shift + relative_opt=$1 + shift + test_expect_success "config diff.relative $relative_opt -p $*" " + short_blob=$(git rev-parse --short $blob_file2) &&
We need to quote the first dollar, in order to run that command inside the test. Current version will run that git-rev-parse outside of the test and interpolated into this command by outer shell.
short_blob=\$(git rev-parse --short $blob_file2) &&
Sorry, I didn't think about this earlier.
t/t4045-diff-relative.sh do · line 123
Quoted 3 lines
t/t4045-diff-relative.sh +3
-0+ test_expect_success "config diff.relative $relative_opt -p $*" " + short_blob_file1=$(git rev-parse --short $blob_file1) && + short_blob_file2=$(git rev-parse --short $blob_file2) &&
This test also needs to quote that dollar.
Beside that, LGTM.
Signature · 1 line
Danh
PATCH v8 1/1 diff: add config option relative
The diff.relative boolean option set to true shows only changes in the current directory/value specified by the path argument of the relative option and shows pathnames relative to the aforementioned directory.
Teach --no-relative to override earlier --relative
Add for git-format-patch(1) options documentation --relative and --no-relative
--- Documentation/config/diff.txt | 4 ++ Documentation/diff-options.txt | 5 ++- diff.c | 11 +++-- t/t4014-format-patch.sh | 13 ++++++ t/t4045-diff-relative.sh | 82 ++++++++++++++++++++++++++++++++-- 5 files changed, 108 insertions(+), 7 deletions(-)
Documentation/config/diff.txt +4 -0
@@ -105,6 +105,10 @@ diff.mnemonicPrefix:: diff.noprefix:: If set, 'git diff' does not show any source or destination prefix. +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.orderFile:: File indicating how to order files within a diff. See the '-O' option to linkgit:git-diff[1] for details.
Documentation/diff-options.txt +4 -1
@@ -643,15 +643,18 @@ ifndef::git-format-patch[] -R:: Swap two inputs; that is, show differences from index or on-disk file to tree contents. +endif::git-format-patch[] --relative[=<path>]:: +--no-relative:: When run from a subdirectory of the project, it can be told to exclude changes outside the directory and show pathnames relative to it with this option. When you are not in a subdirectory (e.g. in a bare repository), you can name which subdirectory to make the output relative to by giving a <path> as an argument. -endif::git-format-patch[] + `--no-relative` can be used to countermand both `diff.relative` config + option and previous `--relative`. -a:: --text::
diff.c +8 -3
@@ -48,6 +48,7 @@ static const char *diff_order_file_cfg;int diff_auto_refresh_index =1 ;static int diff_mnemonic_prefix;static int diff_no_prefix; +static int diff_relative;static int diff_stat_graph_width;static int diff_dirstat_permille_default =30 ;static struct diff_options default_diff_options;
@@ -386,6 +387,10 @@ int git_diff_ui_config(const char *var, const char *value, void *cb) diff_no_prefix =git_config_bool (var, value);return 0 ; } +if (!strcmp (var,"diff.relative" )) { + diff_relative =git_config_bool (var, value); +return 0 ; + }if (!strcmp (var,"diff.statgraphwidth" )) { diff_stat_graph_width =git_config_int (var, value);return 0 ;
@@ -4538,6 +4543,7 @@ void repo_diff_setup(struct repository *r, struct diff_options *options) options->interhunkcontext = diff_interhunk_context_default; options->ws_error_highlight = ws_error_highlight_default; options->flags.rename_empty =1 ; + options->flags.relative_name = diff_relative; options->objfind =NULL ;/* pathchange left =NULL by default */
@@ -5195,8 +5201,7 @@ static int diff_opt_relative(const struct option *opt, {struct diff_options *options = opt->value; -BUG_ON_OPT_NEG (unset); - options->flags.relative_name =1 ; + options->flags.relative_name = !unset;if (arg) options->prefix = arg;return 0 ;
@@ -5492,7 +5497,7 @@ static void prep_parse_options(struct diff_options *options)OPT_GROUP (N_ ("Other diff options" )),OPT_CALLBACK_F (0 ,"relative" , options,N_ ("<prefix>" ),N_ ("when run from subdir, exclude changes outside and show relative paths" ), -PARSE_OPT_NONEG |PARSE_OPT_OPTARG , +PARSE_OPT_OPTARG , diff_opt_relative),OPT_BOOL ('a' ,"text" , &options->flags.text, N_("treat all files as text")),
t/t4014-format-patch.sh +13 -0
@@ -1602,6 +1602,19 @@ test_expect_success 'format patch ignores color.ui' ' test_cmp expect actual ' +test_expect_success 'format patch respects diff.relative' ' + rm -rf subdir && + mkdir subdir && + echo other content >subdir/file2 && + git add subdir/file2 && + git commit -F msg && + test_unconfig diff.relative && + git format-patch --relative=subdir --stdout -1 >expect && + test_config diff.relative true && + git -C subdir format-patch --stdout -1 >actual && + test_cmp expect actual +' + test_expect_success 'cover letter with invalid --cover-from-description and config' ' test_config branch.rebuild-1.description "config subject
t/t4045-diff-relative.sh +79 -3
104 lines not on this page · raw message
--
2.26.2
Hi Laurent,
Quoted 11 lines · Laurent Arnoud
The
diff.relativeboolean option set totrueshows only changes in the current directory/value specified by thepathargument of therelativeoption and shows pathnames relative to the aforementioned directory.Teach
--no-relativeto override earlier--relativeAdd for git-format-patch(1) options documentation
--relativeand--no-relativeSigned-off-by Laurent Arnoud <[email protected]>
Look good to me, I also run those tests and manually tested some usecase I'm interested in.
Signature · 1 line
Danh
Quoted 8 lines · Đoàn Trần Công Danh
Sorry, I didn't think about this earlier.
t/t4045-diff-relative.sh do · line 123
Quoted 3 lines
t/t4045-diff-relative.sh +3
-0+ test_expect_success "config diff.relative $relative_opt -p $*" " + short_blob_file1=$(git rev-parse --short $blob_file1) && + short_blob_file2=$(git rev-parse --short $blob_file2) &&This test also needs to quote that dollar.
Beside that, LGTM.
No worries I've submitted a v8 patch, thanks everyone for the reviews
Signature · 1 line
Laurent
Quoted 12 lines · Đoàn Trần Công Danh
Review void repo_diff_setup(struct repository *r, struct diff_options *options) · line 4567
Quoted 6 lines
(quoted diff) +2
-0@@ -4558,6 +4563,8 @@ void repo_diff_setup(struct repository *r, struct diff_options *options) options->b_prefix = "b/"; } + options->flags.relative_name = diff_relative; +Nitpick:
I don't think this option is too special to add a newline to separate it from the rest :)
Quoted 6 lines
Sorry about not seeing this earlier, I'm a very careless person.
Anyway, I think (just a matter of my _personal_ preference), it's better to move it up 21 lines, together with:
options->flags.rename_empty = 1;
Sounds like a reasonable improvement of readability.
Quoted 14 lines
t/t4045-diff-relative.sh test_expect_success 'setup' ' · line 12
Quoted 11 lines
t/t4045-diff-relative.sh +2
-1@@ -8,7 +8,8 @@ test_expect_success 'setup' ' echo content >file1 && mkdir subdir && echo other content >subdir/file2 && - blob=$(git hash-object subdir/file2) && + blob_file1=$(git hash-object file1) && + blob_file2=$(git hash-object subdir/file2) &&This rename from blob to
blob_file2is a noise to this patch.
Quoted 1 line
Not sure if we should make a preparatory patch to rename, though.
I personally do not mind this one. It is crystal clear from the patch text: "We used to use only one and managed to get away without blob1/blob2 but now we use more than 1, so let's use names with number suffix". On the other hand, a "preparatory patch" that renames blob to blob_file1 before we need the second one is a noise.
Quoted 3 lines
*I* would say yes, and another patch to move all git-related code into test_expect_* family. Then, all new testing code for git in this patch should be placed inside test_expect_*, too.
The latter clean-up to make sure we won't notice Git failure outside test_expect_* block may make sense, but I do not know if we want to make it a preparatory clean-up or "remember to do so later when the dust settles". If this single-patch topic needs to touch only a small part of the existing test to do its job, and such a clean-up ends up touching far wider parts of the script, then I would say we can do so as a post-patch clean-up, not as a part of the topic.
Quoted 7 lines
I think it's better to wait for other's opinions :)
Quoted 4 lines
t/t4045-diff-relative.sh +0
-0@@ -86,4 +87,80 @@ do check_$type . dir/file2 --relative=sub done
Quoted 14 lines
t/t4045-diff-relative.sh do · line 101
Quoted 12 lines
t/t4045-diff-relative.sh +12
-0+ diff --git a/$expect b/$expect + new file mode 100644 + index 0000000..$short_blob_file2 + --- /dev/null + +++ b/$expect + @@ -0,0 +1 @@ + +other content + EOF + test_expect_success "config diff.relative $relative_opt -p $*" " + test_config -C $dir diff.relative $relative_opt && + git -C '$dir' diff -p $* HEAD^ >actual && + git -C '$dir' diff -p $* HEAD^ >/tmp/actual &&Please this leftover from debugging.
Thanks for a careful review, again.
From 478164550f65dfb26e213957d461f0f94fecbcab Mon Sep 17 00:00:00 2001
From: Laurent Arnoud <[email protected]>
Date: Fri, 15 May 2020 19:34:42 +0200
Subject: [PATCH v6] diff: add config option relative
The diff.relative boolean option set to true shows only changes in the current directory/value specified by the path argument of the relative option and shows pathnames relative to the aforementioned directory.
Teach --no-relative to override earlier --relative
--- Documentation/config/diff.txt | 4 ++ Documentation/diff-options.txt | 2 + diff.c | 11 +++-- t/t4014-format-patch.sh | 13 ++++++ t/t4045-diff-relative.sh | 82 ++++++++++++++++++++++++++++++++-- 5 files changed, 106 insertions(+), 6 deletions(-)
Documentation/config/diff.txt +4 -0
@@ -105,6 +105,10 @@ diff.mnemonicPrefix:: diff.noprefix:: If set, 'git diff' does not show any source or destination prefix. +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.orderFile:: File indicating how to order files within a diff. See the '-O' option to linkgit:git-diff[1] for details.
Documentation/diff-options.txt +2 -0
@@ -651,6 +651,8 @@ ifndef::git-format-patch[] not in a subdirectory (e.g. in a bare repository), you can name which subdirectory to make the output relative to by giving a <path> as an argument. + `--no-relative` can be used to countermand both `diff.relative` config + option and previous `--relative`. endif::git-format-patch[] -a::
diff.c +8 -3
@@ -48,6 +48,7 @@ static const char *diff_order_file_cfg;int diff_auto_refresh_index =1 ;static int diff_mnemonic_prefix;static int diff_no_prefix; +static int diff_relative;static int diff_stat_graph_width;static int diff_dirstat_permille_default =30 ;static struct diff_options default_diff_options;
@@ -386,6 +387,10 @@ int git_diff_ui_config(const char *var, const char *value, void *cb) diff_no_prefix =git_config_bool (var, value);return 0 ; } +if (!strcmp (var,"diff.relative" )) { + diff_relative =git_config_bool (var, value); +return 0 ; + }if (!strcmp (var,"diff.statgraphwidth" )) { diff_stat_graph_width =git_config_int (var, value);return 0 ;
@@ -4538,6 +4543,7 @@ void repo_diff_setup(struct repository *r, struct diff_options *options) options->interhunkcontext = diff_interhunk_context_default; options->ws_error_highlight = ws_error_highlight_default; options->flags.rename_empty =1 ; + options->flags.relative_name = diff_relative; options->objfind =NULL ;/* pathchange left =NULL by default */
@@ -5195,8 +5201,7 @@ static int diff_opt_relative(const struct option *opt, {struct diff_options *options = opt->value; -BUG_ON_OPT_NEG (unset); - options->flags.relative_name =1 ; + options->flags.relative_name = !unset;if (arg) options->prefix = arg;return 0 ;
@@ -5492,7 +5497,7 @@ static void prep_parse_options(struct diff_options *options)OPT_GROUP (N_ ("Other diff options" )),OPT_CALLBACK_F (0 ,"relative" , options,N_ ("<prefix>" ),N_ ("when run from subdir, exclude changes outside and show relative paths" ), -PARSE_OPT_NONEG |PARSE_OPT_OPTARG , +PARSE_OPT_OPTARG , diff_opt_relative),OPT_BOOL ('a' ,"text" , &options->flags.text, N_("treat all files as text")),
t/t4014-format-patch.sh +13 -0
@@ -1602,6 +1602,19 @@ test_expect_success 'format patch ignores color.ui' ' test_cmp expect actual ' +test_expect_success 'format patch respects diff.relative' ' + rm -rf subdir && + mkdir subdir && + echo other content >subdir/file2 && + git add subdir/file2 && + git commit -F msg && + test_unconfig diff.relative && + git format-patch --relative=subdir --stdout -1 >expect && + test_config diff.relative true && + git -C subdir format-patch --stdout -1 >actual && + test_cmp expect actual +' + test_expect_success 'cover letter with invalid --cover-from-description and config' ' test_config branch.rebuild-1.description "config subject
t/t4045-diff-relative.sh +79 -3
104 lines not on this page · raw message
Signature · 1 line
2.26.2
Quoted 1 line · Laurent Arnoud
Subject: Re: [PATCH v6] diff: add config option relative
This is not a new problem with this round, but can you stop starting a new iteration that is v6 with "Subject: Re: [PATCH v6]"?
It is good to make v6 a reply to v6, but this is the *first* message that begins v6 iteration, so it is easier to find it without "Re:" prefix.
Thanks.
Quoted 8 lines · Junio C Hamano
Quoted 1 line · Laurent Arnoud
Subject: Re: [PATCH v6] diff: add config option relative
This is not a new problem with this round, but can you stop starting a new iteration that is v6 with "Subject: Re: [PATCH v6]"?
It is good to make v6 a reply to v6, but this is the *first* message
Sorry, "make v6 a reply to v5" is what I meant X-<.
Quoted 4 lines
that begins v6 iteration, so it is easier to find it without "Re:" prefix.
Thanks.
Quoted 11 lines · Laurent Arnoud
The
diff.relativeboolean option set totrueshows only changes in the current directory/value specified by thepathargument of therelativeoption and shows pathnames relative to the aforementioned directory.Teach --no-relative to override earlier --relative
Signed-off-by Laurent Arnoud <[email protected]>---
t/t4014-format-patch.sh do · line 95
Quoted 9 lines
t/t4014-format-patch.sh +9
-0@@ -86,4 +87,79 @@ do +check_diff_relative_option () { + dir=$1 + shift + expect=$1 + shift + relative_opt=$1 + shift + test_expect_success "config diff.relative $relative_opt -p $*" " + short_blob=$(git rev-parse --short "$blob_file2") &&
You're using double quotes inside a double-quote context. (Note that I dropped the quotes around $blob_file2 in the example I gave in order to avoid this problem.)
Quoted 14 lines
t/t4014-format-patch.sh +14
-0+ cat >expected <<-EOF && + diff --git a/$expect b/$expect + new file mode 100644 + index 0000000..\$short_blob + --- /dev/null + +++ b/$expect + @@ -0,0 +1 @@ + +other content + EOF + test_config -C $dir diff.relative $relative_opt && + git -C '$dir' diff -p $* HEAD^ >actual && + test_cmp expected actual + " +}
Documentation/diff-options.txt ifndef::git-format-patch[] · line 655
Quoted 10 lines · Laurent Arnoud
Documentation/diff-options.txt +2
-0@@ -651,6 +651,8 @@ ifndef::git-format-patch[] not in a subdirectory (e.g. in a bare repository), you can name which subdirectory to make the output relative to by giving a <path> as an argument. + `--no-relative` can be used to countermand both `diff.relative` config + option and previous `--relative`.
Nitpick:
Please mentions --no-relative in option list:
Documentation/diff-options.txt +1 -0
@@ -645,6 +645,7 @@ ifndef::git-format-patch[] on-disk file to tree contents. --relative[=<path>]:: +--no-relative:: When run from a subdirectory of the project, it can be told to exclude changes outside the directory and show pathnames relative to it with this option. When you are
Together with Eric suggesstion, this patch looks good to me.
Signature · 1 line
Danh
Quoted 28 lines · Đoàn Trần Công Danh
Documentation/diff-options.txt ifndef::git-format-patch[] · line 655
Quoted 10 lines · Laurent Arnoud
Documentation/diff-options.txt +2
-0@@ -651,6 +651,8 @@ ifndef::git-format-patch[] not in a subdirectory (e.g. in a bare repository), you can name which subdirectory to make the output relative to by giving a <path> as an argument. + `--no-relative` can be used to countermand both `diff.relative` config + option and previous `--relative`.Nitpick:
Please mentions --no-relative in option list:Documentation/diff-options.txt +1
-0@@ -645,6 +645,7 @@ ifndef::git-format-patch[] on-disk file to tree contents. --relative[=<path>]:: +--no-relative:: When run from a subdirectory of the project, it can be told to exclude changes outside the directory and show pathnames relative to it with this option. When you are
Quoted 1 line
Together with Eric suggesstion, this patch looks good to me.
Yeah, good suggestions all.
Thanks.
Laurent Arnoud
AppliedHi Danh,
Quoted 6 lines · Đoàn Trần Công Danh
Thanks for addressing my comment.
Sorry for detecting this late.
Since I usually only look into end of mail-archive to see any interesting topic.
Quoted 8 lines
And sorry for this late email,
I want to run full test before replying with this.I've just seen this:
https://lore.kernel.org/git/[email protected]/I've written some test and concluded that we'll need this fix-up to make sure git-format-patch(1) doesn't generate broken patch:
No worries this Junio is ok for this I've added a test instead in t/t4014-format-patch.sh ensuring that format-patch respects the config diff.relative on the v6 of the patch, let me know what you think
Quoted 5 lines
Nitpick:
I don't think this option is too special to add a newline to separate it from the rest :)
Quoted 7 lines
Sorry about not seeing this earlier, I'm a very careless person.
Anyway, I think (just a matter of my _personal_ preference), it's better to move it up 21 lines, together with:
options->flags.rename_empty = 1;
Applied in the v6
Quoted 4 lines
Quoted 4 lines
(quoted diff) +0
-0@@ -86,4 +87,80 @@ do check_$type . dir/file2 --relative=sub done
Quoted 14 lines
Review do · line 101
Quoted 12 lines
(quoted diff) +12
-0+ diff --git a/$expect b/$expect + new file mode 100644 + index 0000000..$short_blob_file2 + --- /dev/null + +++ b/$expect + @@ -0,0 +1 @@ + +other content + EOF + test_expect_success "config diff.relative $relative_opt -p $*" " + test_config -C $dir diff.relative $relative_opt && + git -C '$dir' diff -p $* HEAD^ >actual && + git -C '$dir' diff -p $* HEAD^ >/tmp/actual &&Please this leftover from debugging.
Opps fixed and thanks again for the review
Signature · 1 line
Laurent
Quoted 22 lines · Laurent Arnoud
The
diff.relativeboolean option set totrueshow only changes on the current directory and show relative pathnames to the current directory.Teach --no-relative to override earlier --relative
Signed-off-by Laurent Arnoud <[email protected]>---
t/t4045-diff-relative.sh +13
-0+check_diff_relative_option () { + dir=$1 + shift + expect=$1 + shift + relative_opt=$1 + shift + short_blob=$(git rev-parse --short "$blob_file2") + cat >expected <<-EOF + diff --git a/$expect b/$expect + new file mode 100644 + index 0000000..$short_blob + --- /dev/null
t/t4045-diff-relative.sh do · line 112
Quoted 10 lines
t/t4045-diff-relative.sh +10
-0+ +++ b/$expect + @@ -0,0 +1 @@ + +other content + EOF + test_expect_success "config diff.relative $relative_opt -p $*" " + test_config -C $dir diff.relative $relative_opt && + git -C '$dir' diff -p $* HEAD^ >actual && + test_cmp expected actual + " +}
Let's move all the setup code into the test itself so that a failure of git-rev-parse will be caught. For instance:
check_diff_relative_option () {
dir=$1
shift
expect=$1
shift
relative_opt=$1
shift
test_expect_success "config diff.relative $relative_opt -p $*" "
short_blob=$(git rev-parse --short $blob_file2) &&
cat >expected <<-EOF &&
diff --git a/$expect b/$expect
new file mode 100644
index 0000000..$short_blob
--- /dev/null
+++ b/$expect
@@ -0,0 +1 @@
+other content
EOF
test_config -C $dir diff.relative $relative_opt &&
git -C '$dir' diff -p $* HEAD^ >actual &&
test_cmp expected actual "
}
Same comment applies to the other new function added by this patch.
Quoted 27 lines · Eric Sunshine
Let's move all the setup code into the test itself so that a failure of git-rev-parse will be caught. For instance:
check_diff_relative_option () { dir=$1 shift expect=$1 shift relative_opt=$1 shift test_expect_success "config diff.relative $relative_opt -p $*" " short_blob=$(git rev-parse --short $blob_file2) && cat >expected <<-EOF && diff --git a/$expect b/$expect new file mode 100644 index 0000000..$short_blob --- /dev/null +++ b/$expect @@ -0,0 +1 @@ +other content EOF test_config -C $dir diff.relative $relative_opt && git -C '$dir' diff -p $* HEAD^ >actual && test_cmp expected actual " }
Quoted 1 line
Same comment applies to the other new function added by this patch.
Thanks its applied on the v6 patch
Signature · 1 line
Laurent
Hi Danh,
Quoted 2 lines · Đoàn Trần Công Danh
Above comment also applied here.
And remove this debug cat.
Oops thanks for the review I've submitted a v5 for review let me know if I responded to all your feedbacks
Signature · 1 line
Laurent
Quoted 4 lines · Phillip Wood
Quoted 4 lines
diff.c +0
-0@@ -5494,6 +5501,9 @@ static void prep_parse_options(struct diff_options *options)N_ ("when run from subdir, exclude changes outside and show relative paths" ),PARSE_OPT_NONEG |PARSE_OPT_OPTARG , diff_opt_relative),
Quoted 8 lines
diff.c static void prep_parse_options(struct diff_options *options) · line 5506
Quoted 3 lines
diff.c +3
-0+OPT_SET_INT_F (0 ,"no-relative" , &options->flags.relative_name, +N_ ("disable diff.relative config option" ), + 0, PARSE_OPT_NONEG),Rather than adding a new option, it would be better to modify the existing --relative option. If you remove
PARSE_OPT_NONEGfrom the declaration above it will support --no-relative. You will also need to modifydiff_opt_relative()to handle clearing the option.
Excellent.