]>
Commit | Line | Data |
---|---|---|
beb188e2 | 1 | #!/bin/sh |
7a76f5c6 JK |
2 | # |
3 | # Build two documentation trees and diff the resulting formatted output. | |
4 | # Compared to a source diff, this can reveal mistakes in the formatting. | |
5 | # For example: | |
6 | # | |
7 | # ./doc-diff origin/master HEAD | |
8 | # | |
9 | # would show the differences introduced by a branch based on master. | |
beb188e2 JK |
10 | |
11 | OPTIONS_SPEC="\ | |
12 | doc-diff [options] <from> <to> [-- <diff-options>] | |
ad517430 | 13 | doc-diff (-c|--clean) |
beb188e2 JK |
14 | -- |
15 | j=n parallel argument to pass to make | |
16 | f force rebuild; do not rely on cached results | |
ad517430 | 17 | c,clean cleanup temporary working files |
beb188e2 JK |
18 | " |
19 | SUBDIRECTORY_OK=1 | |
20 | . "$(git --exec-path)/git-sh-setup" | |
21 | ||
22 | parallel= | |
23 | force= | |
ad517430 | 24 | clean= |
beb188e2 JK |
25 | while test $# -gt 0 |
26 | do | |
27 | case "$1" in | |
28 | -j) | |
29 | parallel=$2; shift ;; | |
ad517430 ES |
30 | -c|--clean) |
31 | clean=t ;; | |
beb188e2 JK |
32 | -f) |
33 | force=t ;; | |
34 | --) | |
35 | shift; break ;; | |
36 | *) | |
37 | usage ;; | |
38 | esac | |
39 | shift | |
40 | done | |
41 | ||
2afe9278 | 42 | tmp="$(git rev-parse --show-toplevel)/Documentation/tmp-doc-diff" || exit 1 |
ad517430 ES |
43 | |
44 | if test -n "$clean" | |
45 | then | |
46 | test $# -eq 0 || usage | |
47 | git worktree remove --force "$tmp/worktree" 2>/dev/null | |
48 | rm -rf "$tmp" | |
49 | exit 0 | |
50 | fi | |
51 | ||
beb188e2 JK |
52 | if test -z "$parallel" |
53 | then | |
54 | parallel=$(getconf _NPROCESSORS_ONLN 2>/dev/null) | |
55 | if test $? != 0 || test -z "$parallel" | |
56 | then | |
57 | parallel=1 | |
58 | fi | |
59 | fi | |
60 | ||
61 | test $# -gt 1 || usage | |
62 | from=$1; shift | |
63 | to=$1; shift | |
64 | ||
65 | from_oid=$(git rev-parse --verify "$from") || exit 1 | |
66 | to_oid=$(git rev-parse --verify "$to") || exit 1 | |
67 | ||
beb188e2 JK |
68 | if test -n "$force" |
69 | then | |
70 | rm -rf "$tmp" | |
71 | fi | |
72 | ||
73 | # We'll do both builds in a single worktree, which lets "make" reuse | |
74 | # results that don't differ between the two trees. | |
75 | if ! test -d "$tmp/worktree" | |
76 | then | |
684e7422 | 77 | git worktree add -f --detach "$tmp/worktree" "$from" && |
beb188e2 JK |
78 | dots=$(echo "$tmp/worktree" | sed 's#[^/]*#..#g') && |
79 | ln -s "$dots/config.mak" "$tmp/worktree/config.mak" | |
80 | fi | |
81 | ||
bc71dc3f MÅ |
82 | from_dir=$from_oid && |
83 | to_dir=$to_oid && | |
84 | ||
beb188e2 JK |
85 | # generate_render_makefile <srcdir> <dstdir> |
86 | generate_render_makefile () { | |
87 | find "$1" -type f | | |
88 | while read src | |
89 | do | |
90 | dst=$2/${src#$1/} | |
91 | printf 'all:: %s\n' "$dst" | |
92 | printf '%s: %s\n' "$dst" "$src" | |
93 | printf '\t@echo >&2 " RENDER $(notdir $@)" && \\\n' | |
94 | printf '\tmkdir -p $(dir $@) && \\\n' | |
83d4b5ff | 95 | printf '\tMANWIDTH=80 man $< >$@+ && \\\n' |
beb188e2 JK |
96 | printf '\tmv $@+ $@\n' |
97 | done | |
98 | } | |
99 | ||
bc71dc3f | 100 | # render_tree <committish_oid> <directory_name> |
beb188e2 JK |
101 | render_tree () { |
102 | # Skip install-man entirely if we already have an installed directory. | |
103 | # We can't rely on make here, since "install-man" unconditionally | |
104 | # copies the files (spending effort, but also updating timestamps that | |
105 | # we then can't rely on during the render step). We use "mv" to make | |
106 | # sure we don't get confused by a previous run that failed partway | |
107 | # through. | |
bc71dc3f MÅ |
108 | oid=$1 && |
109 | dname=$2 && | |
110 | if ! test -d "$tmp/installed/$dname" | |
beb188e2 | 111 | then |
bc71dc3f | 112 | git -C "$tmp/worktree" checkout --detach "$oid" && |
beb188e2 JK |
113 | make -j$parallel -C "$tmp/worktree" \ |
114 | GIT_VERSION=omitted \ | |
115 | SOURCE_DATE_EPOCH=0 \ | |
bc71dc3f | 116 | DESTDIR="$tmp/installed/$dname+" \ |
beb188e2 | 117 | install-man && |
bc71dc3f | 118 | mv "$tmp/installed/$dname+" "$tmp/installed/$dname" |
beb188e2 JK |
119 | fi && |
120 | ||
121 | # As with "installed" above, we skip the render if it's already been | |
122 | # done. So using make here is primarily just about running in | |
123 | # parallel. | |
bc71dc3f | 124 | if ! test -d "$tmp/rendered/$dname" |
beb188e2 | 125 | then |
bc71dc3f MÅ |
126 | generate_render_makefile "$tmp/installed/$dname" \ |
127 | "$tmp/rendered/$dname+" | | |
beb188e2 | 128 | make -j$parallel -f - && |
bc71dc3f | 129 | mv "$tmp/rendered/$dname+" "$tmp/rendered/$dname" |
beb188e2 JK |
130 | fi |
131 | } | |
132 | ||
bc71dc3f MÅ |
133 | render_tree $from_oid $from_dir && |
134 | render_tree $to_oid $to_dir && | |
135 | git -C $tmp/rendered diff --no-index "$@" $from_dir $to_dir |