doc-diff: always use oids inside worktree

The doc-diff script immediately resolves its two endpoints to actual object ids, so that we can reuse cached results even if they appear under a different name. But we still use the original name the user fed us when running "git checkout" in our temporary worktree. This can lead to confusing results: - the namespace inside the worktree is different than the one outside. In particular, "./doc-diff origin HEAD" will resolve HEAD inside the worktree, whose detached HEAD will be pointing at origin! As a result, such a diff would always be empty. - worse, we will store this result under the oid we got by resolving HEAD in the main worktree, thus polluting our cache - we didn't pass --detach, which meant that using a branch name would cause us to actually check out that branch, making it unavailable to other worktrees. We can solve this by feeding the already-resolved object id to git-checkout. That naturally forces a detached HEAD, but just to make clear our expectation, let's explicitly pass --detach. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Jeff King committed Aug 30, 2018 at 04:12 UTC 27064fb7fb82d607f3e2ccc5e9c93e0161bae134
1 file changed +4 -4
Documentation/doc-diff
+4 -4
@@ -82,7 +82,7 @@ generate_render_makefile () {
82 done
83 }
84
85 -# render_tree <dirname> <committish>
85 +# render_tree <committish_oid>
86 render_tree () {
87 # Skip install-man entirely if we already have an installed directory.
88 # We can't rely on make here, since "install-man" unconditionally
@@ -92,7 +92,7 @@ render_tree () {
92 # through.
93 if ! test -d "$tmp/installed/$1"
94 then
95 - git -C "$tmp/worktree" checkout "$2" &&
95 + git -C "$tmp/worktree" checkout --detach "$1" &&
96 make -j$parallel -C "$tmp/worktree" \
97 GIT_VERSION=omitted \
98 SOURCE_DATE_EPOCH=0 \
@@ -112,6 +112,6 @@ render_tree () {
112 fi
113 }
114
115 -render_tree $from_oid "$from" &&
116 -render_tree $to_oid "$to" &&
115 +render_tree $from_oid &&
116 +render_tree $to_oid &&
117 git -C $tmp/rendered diff --no-index "$@" $from_oid $to_oid