diff options
author | Jeff King <peff@peff.net> | 2018-08-06 13:37:20 -0400 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2018-08-06 12:30:23 -0700 |
commit | beb188e22ad0ca4287984c316c7e0b0f9aa895e6 (patch) | |
tree | 3e9673591b2e7dd27cd1392345ab6bc7ab261163 /Documentation/technical/api-merge.txt | |
parent | Fifth batch for 2.19 cycle (diff) | |
download | tgif-beb188e22ad0ca4287984c316c7e0b0f9aa895e6.tar.xz |
add a script to diff rendered documentation
After making a change to the documentation, it's easy to
forget to check the rendered version to make sure it was
formatted as you intended. And simply doing a diff between
the two built versions is less trivial than you might hope:
- diffing the roff or html output isn't particularly
readable; what we really care about is what the end user
will see
- you have to tweak a few build variables to avoid
spurious differences (e.g., version numbers, build
times)
Let's provide a script that builds and installs the manpages
for two commits, renders the results using "man", and diffs
the result. Since this is time-consuming, we'll also do our
best to avoid repeated work, keeping intermediate results
between runs.
Some of this could probably be made a little less ugly if we
built support into Documentation/Makefile. But by relying
only on "make install-man" working, this script should work
for generating a diff between any two versions, whether they
include this script or not.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/technical/api-merge.txt')
0 files changed, 0 insertions, 0 deletions