* [PATCH v2 3/3] difftool: handle modified symlinks in dir-diff mode
@ 2017-03-15 9:31 David Aguilar
2017-03-15 18:54 ` Junio C Hamano
0 siblings, 1 reply; 3+ messages in thread
From: David Aguilar @ 2017-03-15 9:31 UTC (permalink / raw)
To: Git ML; +Cc: Johannes Schindelin, Junio C Hamano, Christophe Macabiau
Detect the null object ID for symlinks in dir-diff so that difftool can
detect when symlinks are modified in the worktree.
Previously, a null symlink object ID would crash difftool.
Handle null object IDs as unknown content that must be read from
the worktree.
Helped-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: David Aguilar <davvid@gmail.com>
---
Only 3/3 was re-sent; the rest are the same.
When re-reading the patch I noticed two spots where spurious
whitespace was added. I've dropped those hunks.
builtin/difftool.c | 51 ++++++++++++++++++++++++++++++++++++++++-----
t/t7800-difftool.sh | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 106 insertions(+), 5 deletions(-)
diff --git a/builtin/difftool.c b/builtin/difftool.c
index d13350ce83..25e54ad3ed 100644
--- a/builtin/difftool.c
+++ b/builtin/difftool.c
@@ -254,6 +254,49 @@ static int ensure_leading_directories(char *path)
}
}
+/*
+ * Unconditional writing of a plain regular file is what
+ * "git difftool --dir-diff" wants to do for symlinks. We are preparing two
+ * temporary directories to be fed to a Git-unaware tool that knows how to
+ * show a diff of two directories (e.g. "diff -r A B").
+ *
+ * Because the tool is Git-unaware, if a symbolic link appears in either of
+ * these temporary directories, it will try to dereference and show the
+ * difference of the target of the symbolic link, which is not what we want,
+ * as the goal of the dir-diff mode is to produce an output that is logically
+ * equivalent to what "git diff" produces.
+ *
+ * Most importantly, we want to get textual comparison of the result of the
+ * readlink(2). get_symlink() provides that---it returns the contents of
+ * the symlink that gets written to a regular file to force the external tool
+ * to compare the readlink(2) result as text, even on a filesystem that is
+ * capable of doing a symbolic link.
+ */
+static char *get_symlink(const struct object_id *oid, const char *path)
+{
+ char *data;
+ if (is_null_oid(oid)) {
+ /* The symlink is unknown to Git so read from the filesystem */
+ struct strbuf link = STRBUF_INIT;
+ if (has_symlinks) {
+ if (strbuf_readlink(&link, path, strlen(path)))
+ die(_("could not read symlink %s"), path);
+ } else if (strbuf_read_file(&link, path, 128))
+ die(_("could not read symlink file %s"), path);
+
+ data = strbuf_detach(&link, NULL);
+ } else {
+ enum object_type type;
+ unsigned long size;
+ data = read_sha1_file(oid->hash, &type, &size);
+ if (!data)
+ die(_("could not read object %s for symlink %s"),
+ oid_to_hex(oid), path);
+ }
+
+ return data;
+}
+
static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
int argc, const char **argv)
{
@@ -270,8 +313,6 @@ static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
struct hashmap working_tree_dups, submodules, symlinks2;
struct hashmap_iter iter;
struct pair_entry *entry;
- enum object_type type;
- unsigned long size;
struct index_state wtindex;
struct checkout lstate, rstate;
int rc, flags = RUN_GIT_CMD, err = 0;
@@ -377,13 +418,13 @@ static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
}
if (S_ISLNK(lmode)) {
- char *content = read_sha1_file(loid.hash, &type, &size);
+ char *content = get_symlink(&loid, src_path);
add_left_or_right(&symlinks2, src_path, content, 0);
free(content);
}
if (S_ISLNK(rmode)) {
- char *content = read_sha1_file(roid.hash, &type, &size);
+ char *content = get_symlink(&roid, dst_path);
add_left_or_right(&symlinks2, dst_path, content, 1);
free(content);
}
@@ -397,7 +438,7 @@ static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
return error("could not write '%s'", src_path);
}
- if (rmode) {
+ if (rmode && !S_ISLNK(rmode)) {
struct working_tree_entry *entry;
/* Avoid duplicate working_tree entries */
diff --git a/t/t7800-difftool.sh b/t/t7800-difftool.sh
index e0e65df8de..0e7f30db2d 100755
--- a/t/t7800-difftool.sh
+++ b/t/t7800-difftool.sh
@@ -626,4 +626,64 @@ test_expect_success SYMLINKS 'difftool --dir-diff symlinked directories' '
)
'
+test_expect_success SYMLINKS 'difftool --dir-diff handles modified symlinks' '
+ test_when_finished git reset --hard &&
+ touch b &&
+ ln -s b c &&
+ git add b c &&
+ test_tick &&
+ git commit -m initial &&
+ touch d &&
+ rm c &&
+ ln -s d c &&
+ cat >expect <<-EOF &&
+ b
+ c
+
+ c
+ EOF
+ git difftool --symlinks --dir-diff --extcmd ls >output &&
+ grep -v ^/ output >actual &&
+ test_cmp expect actual &&
+
+ git difftool --no-symlinks --dir-diff --extcmd ls >output &&
+ grep -v ^/ output >actual &&
+ test_cmp expect actual &&
+
+ # The left side contains symlink "c" that points to "b"
+ test_config difftool.cat.cmd "cat \$LOCAL/c" &&
+ printf "%s\n" b >expect &&
+
+ git difftool --symlinks --dir-diff --tool cat >actual &&
+ test_cmp expect actual &&
+
+ git difftool --symlinks --no-symlinks --dir-diff --tool cat >actual &&
+ test_cmp expect actual &&
+
+ # The right side contains symlink "c" that points to "d"
+ test_config difftool.cat.cmd "cat \$REMOTE/c" &&
+ printf "%s\n" d >expect &&
+
+ git difftool --symlinks --dir-diff --tool cat >actual &&
+ test_cmp expect actual &&
+
+ git difftool --no-symlinks --dir-diff --tool cat >actual &&
+ test_cmp expect actual &&
+
+ # Deleted symlinks
+ rm -f c &&
+ cat >expect <<-EOF &&
+ b
+ c
+
+ EOF
+ git difftool --symlinks --dir-diff --extcmd ls >output &&
+ grep -v ^/ output >actual &&
+ test_cmp expect actual &&
+
+ git difftool --no-symlinks --dir-diff --extcmd ls >output &&
+ grep -v ^/ output >actual &&
+ test_cmp expect actual
+'
+
test_done
--
2.12.0.309.g054a7c81e7
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH v2 3/3] difftool: handle modified symlinks in dir-diff mode
2017-03-15 9:31 [PATCH v2 3/3] difftool: handle modified symlinks in dir-diff mode David Aguilar
@ 2017-03-15 18:54 ` Junio C Hamano
2017-03-15 20:58 ` David Aguilar
0 siblings, 1 reply; 3+ messages in thread
From: Junio C Hamano @ 2017-03-15 18:54 UTC (permalink / raw)
To: David Aguilar; +Cc: Git ML, Johannes Schindelin, Christophe Macabiau
David Aguilar <davvid@gmail.com> writes:
> Detect the null object ID for symlinks in dir-diff so that difftool can
> detect when symlinks are modified in the worktree.
>
> Previously, a null symlink object ID would crash difftool.
> Handle null object IDs as unknown content that must be read from
> the worktree.
>
> Helped-by: Johannes Schindelin <johannes.schindelin@gmx.de>
> Signed-off-by: David Aguilar <davvid@gmail.com>
> ---
> Only 3/3 was re-sent; the rest are the same.
OK, so in short you did the get_symlink() thing that was brought up
in the previous round of review and everything else fell out as a
natural consequence? That is wonderful ;-)
> @@ -397,7 +438,7 @@ static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
> return error("could not write '%s'", src_path);
> }
>
> - if (rmode) {
> + if (rmode && !S_ISLNK(rmode)) {
> struct working_tree_entry *entry;
It still makes me wonder why the new !S_ISLNK() is done only for the
right hand side, though. In fact, the processing done for the left
hand side and the right hand side are vastly different even without
this patch.
I suspect this is probably because the code is not prepared to drive
the underlying "diff" when given the "-R" option (if I am reading
the code correctly, argv[] that came from the end-user is appended
to "diff --raw --no-abbrev -z", so the user could ask "difftool
--dir-diff -R ..."), in which case you would see the working tree
files as the left hand side of the diff. In the dir-diff mode,
because you want to make only the working-tree side writable (and
reflect whatever edit the user made back to the working-tree side),
the choices you have to fix it would either be forbid "-R" (which is
less preferrable as it is a more brittle solution between the two)
or read the "diff --raw" output and swap the sides when you notice
that LHS has 0{40} with non 0 mode, which is a sign that that side
represents the working tree.
Having said all that, let's focus on the "symlink" stuff in this
series.
Thanks.
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH v2 3/3] difftool: handle modified symlinks in dir-diff mode
2017-03-15 18:54 ` Junio C Hamano
@ 2017-03-15 20:58 ` David Aguilar
0 siblings, 0 replies; 3+ messages in thread
From: David Aguilar @ 2017-03-15 20:58 UTC (permalink / raw)
To: Junio C Hamano; +Cc: Git ML, Johannes Schindelin, Christophe Macabiau
On Wed, Mar 15, 2017 at 11:54:14AM -0700, Junio C Hamano wrote:
> David Aguilar <davvid@gmail.com> writes:
>
> > @@ -397,7 +438,7 @@ static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
> > return error("could not write '%s'", src_path);
> > }
> >
> > - if (rmode) {
> > + if (rmode && !S_ISLNK(rmode)) {
> > struct working_tree_entry *entry;
>
> It still makes me wonder why the new !S_ISLNK() is done only for the
> right hand side, though. In fact, the processing done for the left
> hand side and the right hand side are vastly different even without
> this patch.
>
> I suspect this is probably because the code is not prepared to drive
> the underlying "diff" when given the "-R" option (if I am reading
> the code correctly, argv[] that came from the end-user is appended
> to "diff --raw --no-abbrev -z", so the user could ask "difftool
> --dir-diff -R ..."), in which case you would see the working tree
> files as the left hand side of the diff. In the dir-diff mode,
> because you want to make only the working-tree side writable (and
> reflect whatever edit the user made back to the working-tree side),
> the choices you have to fix it would either be forbid "-R" (which is
> less preferrable as it is a more brittle solution between the two)
> or read the "diff --raw" output and swap the sides when you notice
> that LHS has 0{40} with non 0 mode, which is a sign that that side
> represents the working tree.
>
> Having said all that, let's focus on the "symlink" stuff in this
> series.
>
> Thanks.
Agreed. I can take a look at the reverse-diff
question later this week separately from this issue.
The symlink test case I just added can be used as a starting
ground for adding reverse-diff tests.
Thanks Junio and Dscho for the reviews,
--
David
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2017-03-15 20:58 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-03-15 9:31 [PATCH v2 3/3] difftool: handle modified symlinks in dir-diff mode David Aguilar
2017-03-15 18:54 ` Junio C Hamano
2017-03-15 20:58 ` David Aguilar
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.