]> git.ipfire.org Git - thirdparty/git.git/commitdiff
diff-highlight: mention build instructions
authorJeff King <peff@peff.net>
Mon, 23 Mar 2026 06:01:58 +0000 (02:01 -0400)
committerJunio C Hamano <gitster@pobox.com>
Mon, 23 Mar 2026 14:42:26 +0000 (07:42 -0700)
Once upon a time, this was just a script in a directory that could be
run directly. That changed in 0c977dbc81 (diff-highlight: split code
into module, 2017-06-15). Let's update the README to make it more clear
that you need to run make.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
contrib/diff-highlight/README

index 1db4440e68324d3695d36eada3a1f241bd10bf7d..9c89146fb0a1cbffe9201be5740fcc9337493b27 100644 (file)
@@ -39,10 +39,21 @@ visually distracting.  Non-diff lines and existing diff coloration is
 preserved; the intent is that the output should look exactly the same as
 the input, except for the occasional highlight.
 
+Build/Install
+-------------
+
+You can build the `diff-highlight` script by running `make` from within
+the diff-highlight directory. There is no `make install` target; you can
+copy the built script to your $PATH.
+
+You can run diff-highlight's internal tests by running `make test`. Note
+that you must also build Git itself first (by running `make` from the
+top-level of the project).
+
 Use
 ---
 
-You can try out the diff-highlight program with:
+You can try out the built diff-highlight program with:
 
 ---------------------------------------------
 git log -p --color | /path/to/diff-highlight