Merge branch 'nd/the-index'

diff --git a/Documentation/doc-diff b/Documentation/doc-diff
index f483fe427cea4c82ebe69fc67f3a8efd3d53ec9c..dfd9418778a80a209e8ceb43aa94dbb4259f91db 100755 (executable)
--- a/Documentation/doc-diff
+++ b/Documentation/doc-diff
@@ -1,21 +1,34 @@
 #!/bin/sh
+#
+# Build two documentation trees and diff the resulting formatted output.
+# Compared to a source diff, this can reveal mistakes in the formatting.
+# For example:
+#
+#   ./doc-diff origin/master HEAD
+#
+# would show the differences introduced by a branch based on master.
 
 OPTIONS_SPEC="\
 doc-diff [options] <from> <to> [-- <diff-options>]
+doc-diff (-c|--clean)
 --
 j=n    parallel argument to pass to make
 f      force rebuild; do not rely on cached results
+c,clean        cleanup temporary working files
 "
 SUBDIRECTORY_OK=1
 . "$(git --exec-path)/git-sh-setup"
 
 parallel=
 force=
+clean=
 while test $# -gt 0
 do
        case "$1" in
        -j)
                parallel=$2; shift ;;
+       -c|--clean)
+               clean=t ;;
        -f)
                force=t ;;
        --)
@@ -26,6 +39,17 @@ do
        shift
 done
 
+cd_to_toplevel
+tmp=Documentation/tmp-doc-diff
+
+if test -n "$clean"
+then
+       test $# -eq 0 || usage
+       git worktree remove --force "$tmp/worktree" 2>/dev/null
+       rm -rf "$tmp"
+       exit 0
+fi
+
 if test -z "$parallel"
 then
        parallel=$(getconf _NPROCESSORS_ONLN 2>/dev/null)
@@ -42,9 +66,6 @@ to=$1; shift
 from_oid=$(git rev-parse --verify "$from") || exit 1
 to_oid=$(git rev-parse --verify "$to") || exit 1
 
-cd_to_toplevel
-tmp=Documentation/tmp-doc-diff
-
 if test -n "$force"
 then
        rm -rf "$tmp"
@@ -54,7 +75,7 @@ fi
 # results that don't differ between the two trees.
 if ! test -d "$tmp/worktree"
 then
-       git worktree add --detach "$tmp/worktree" "$from" &&
+       git worktree add -f --detach "$tmp/worktree" "$from" &&
        dots=$(echo "$tmp/worktree" | sed 's#[^/]*#..#g') &&
        ln -s "$dots/config.mak" "$tmp/worktree/config.mak"
 fi
@@ -69,12 +90,12 @@ generate_render_makefile () {
                printf '%s: %s\n' "$dst" "$src"
                printf '\t@echo >&2 "  RENDER $(notdir $@)" && \\\n'
                printf '\tmkdir -p $(dir $@) && \\\n'
-               printf '\tMANWIDTH=80 man -l $< >$@+ && \\\n'
+               printf '\tMANWIDTH=80 man $< >$@+ && \\\n'
                printf '\tmv $@+ $@\n'
        done
 }
 
-# render_tree <dirname> <committish>
+# render_tree <committish_oid>
 render_tree () {
        # Skip install-man entirely if we already have an installed directory.
        # We can't rely on make here, since "install-man" unconditionally
@@ -84,7 +105,7 @@ render_tree () {
        # through.
        if ! test -d "$tmp/installed/$1"
        then
-               git -C "$tmp/worktree" checkout "$2" &&
+               git -C "$tmp/worktree" checkout --detach "$1" &&
                make -j$parallel -C "$tmp/worktree" \
                        GIT_VERSION=omitted \
                        SOURCE_DATE_EPOCH=0 \
@@ -104,6 +125,6 @@ render_tree () {
        fi
 }
 
-render_tree $from_oid "$from" &&
-render_tree $to_oid "$to" &&
+render_tree $from_oid &&
+render_tree $to_oid &&
 git -C $tmp/rendered diff --no-index "$@" $from_oid $to_oid