public inbox for git@vger.kernel.org
 help / color / mirror / Atom feed
From: Jeff King <peff@peff.net>
To: git@vger.kernel.org
Cc: Tian Yuchen <a3205153416@gmail.com>, Scott Baker <scott@perturb.org>
Subject: [PATCH v2 1/8] diff-highlight: mention build instructions
Date: Mon, 23 Mar 2026 02:01:58 -0400	[thread overview]
Message-ID: <20260323060158.GA10482@coredump.intra.peff.net> (raw)
In-Reply-To: <20260323060139.GA10215@coredump.intra.peff.net>

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>
---
 contrib/diff-highlight/README | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/contrib/diff-highlight/README b/contrib/diff-highlight/README
index 1db4440e68..9c89146fb0 100644
--- a/contrib/diff-highlight/README
+++ b/contrib/diff-highlight/README
@@ -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
-- 
2.53.0.1051.ga14e96f895


  reply	other threads:[~2026-03-23  6:01 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-03-20  0:41 [PATCH 0/8] some diff-highlight tweaks Jeff King
2026-03-20  0:42 ` [PATCH 1/8] diff-highlight: mention build instructions Jeff King
2026-03-20  0:42 ` [PATCH 2/8] diff-highlight: drop perl version dependency back to 5.8 Jeff King
2026-03-20  0:43 ` [PATCH 3/8] diff-highlight: check diff-highlight exit status in tests Jeff King
2026-03-20  0:43 ` [PATCH 4/8] t: add matching negative attributes to test_decode_color Jeff King
2026-03-20  0:44 ` [PATCH 5/8] diff-highlight: use test_decode_color in tests Jeff King
2026-03-22 17:24   ` Tian Yuchen
2026-03-22 20:47     ` Jeff King
2026-03-23  5:48       ` Tian Yuchen
2026-03-23  5:53         ` Jeff King
2026-03-20  0:45 ` [PATCH 6/8] diff-highlight: test color config Jeff King
2026-03-20  0:47 ` [PATCH 7/8] diff-highlight: allow module callers to pass in " Jeff King
2026-03-20  0:48 ` [PATCH 8/8] diff-highlight: fetch all config with one process Jeff King
2026-03-22 17:18   ` Tian Yuchen
2026-03-22 20:45     ` Jeff King
2026-03-23  5:39       ` Tian Yuchen
2026-03-23  5:57         ` Jeff King
2026-03-23  6:01 ` [PATCH v2 0/8] some diff-highlight tweaks Jeff King
2026-03-23  6:01   ` Jeff King [this message]
2026-03-23  6:02   ` [PATCH v2 2/8] diff-highlight: drop perl version dependency back to 5.8 Jeff King
2026-03-23  6:02   ` [PATCH v2 3/8] diff-highlight: check diff-highlight exit status in tests Jeff King
2026-03-23  6:02   ` [PATCH v2 4/8] t: add matching negative attributes to test_decode_color Jeff King
2026-03-23  6:02   ` [PATCH v2 5/8] diff-highlight: use test_decode_color in tests Jeff King
2026-03-23  6:02   ` [PATCH v2 6/8] diff-highlight: test color config Jeff King
2026-03-23  6:02   ` [PATCH v2 7/8] diff-highlight: allow module callers to pass in " Jeff King
2026-03-23  6:02   ` [PATCH v2 8/8] diff-highlight: fetch all config with one process Jeff King
2026-03-23 16:38   ` [PATCH v2 0/8] some diff-highlight tweaks Junio C Hamano
2026-03-24  6:50     ` Patrick Steinhardt

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260323060158.GA10482@coredump.intra.peff.net \
    --to=peff@peff.net \
    --cc=a3205153416@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=scott@perturb.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox