git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 1/2] fix pager.diff with diff --no-index

From
Jeff King <peff@peff.net>
Date
Jun 15, 2012, 20:29 UTC
Message-ID
<20120615202948.GA12326@sigill.intra.peff.net>
In-Reply-To
<20120615202813.GA12253@sigill.intra.peff.net>

git-diff does not rely on the git wrapper to setup its pager; instead, it sets it up on its own after seeing whether --quiet or --exit-code has been specified. After diff_no_index was split off from cmd_diff, commit b3fde6c (git diff --no-index: default to page like other diff frontends, 2008-05-26) duplicated the one-liner from cmd_diff to turn on the pager.

Later, commit 8f0359f (Allow pager of diff command be enabled/disabled, 2008-07-21) taught the the version in cmd_diff to respect the pager.diff config, but the version in diff_no_index was left behind. This meant that

  git -c pager.diff=0 diff a b
would not use a pager, but
  git -c pager.diff=0 diff --no-index a b
would.  Let's fix it by factoring out a common function.

While we're there, let's update the antiquated comment, which claims that the pager interferes with propagating the exit code; this has not been the case since ea27a18 (spawn pager via run_command interface, 2008-07-22).

Signed-off-by: Jeff King <peff@peff.net>
---
 builtin.h       |  2 ++
 builtin/diff.c  | 24 +++++++++++++++++-------
 diff-no-index.c |  7 +------
 3 files changed, 20 insertions(+), 13 deletions(-)
diff --git a/builtin.h b/builtin.h
index 338f540..e426de3 100644
--- a/builtin.h
+++ b/builtin.h
@@ -41,6 +41,8 @@ int copy_note_for_rewrite(struct notes_rewrite_cfg *c,
 void finish_copy_notes_for_rewrite(struct notes_rewrite_cfg *c);
 
 extern int check_pager_config(const char *cmd);
+struct diff_options;
+extern void setup_diff_pager(struct diff_options *);
 
 extern int textconv_object(const char *path, unsigned mode, const unsigned char *sha1, char **buf, unsigned long *buf_size);
 
diff --git a/builtin/diff.c b/builtin/diff.c
index 9069dc4..da8f6aa 100644
--- a/builtin/diff.c
+++ b/builtin/diff.c
@@ -304,13 +304,7 @@ int cmd_diff(int argc, const char **argv, const char *prefix)
 
 	DIFF_OPT_SET(&rev.diffopt, RECURSIVE);
 
-	/*
-	 * If the user asked for our exit code then don't start a
-	 * pager or we would end up reporting its exit code instead.
-	 */
-	if (!DIFF_OPT_TST(&rev.diffopt, EXIT_WITH_STATUS) &&
-	    check_pager_config("diff") != 0)
-		setup_pager();
+	setup_diff_pager(&rev.diffopt);
 
 	/*
 	 * Do we have --cached and not have a pending object, then
@@ -421,3 +415,19 @@ int cmd_diff(int argc, const char **argv, const char *prefix)
 		refresh_index_quietly();
 	return result;
 }
+
+void setup_diff_pager(struct diff_options *opt)
+{
+	/*
+	 * If the user asked for our exit code, then either they want --quiet
+	 * or --exit-code. We should definitely not bother with a pager in the
+	 * former case, as we will generate no output. Since we still properly
+	 * report our exit code even when a pager is run, we _could_ run a
+	 * pager with --exit-code. But since we have not done so historically,
+	 * and because it is easy to find people oneline advising "git diff
+	 * --exit-code" in hooks and other scripts, we do not do so.
+	 */
+	if (!DIFF_OPT_TST(opt, EXIT_WITH_STATUS) &&
+	    check_pager_config("diff") != 0)
+		setup_pager();
+}
diff --git a/diff-no-index.c b/diff-no-index.c
index f0b0010..fc1decd 100644
--- a/diff-no-index.c
+++ b/diff-no-index.c
@@ -224,12 +224,7 @@ void diff_no_index(struct rev_info *revs,
 		}
 	}
 
-	/*
-	 * If the user asked for our exit code then don't start a
-	 * pager or we would end up reporting its exit code instead.
-	 */
-	if (!DIFF_OPT_TST(&revs->diffopt, EXIT_WITH_STATUS))
-		setup_pager();
+	setup_diff_pager(&revs->diffopt);
 
 	if (prefix) {
 		int len = strlen(prefix);
-- 
1.7.11.rc2.4.g0b9de53
Previous: Jeff KingNext: Jeff King
Message 2 of 4 in “diff --no-index pager cleanups”
  1. 0/2 diff --no-index pager cleanupsJeff King, Jun 15, 2012
  2. 1/2 fix pager.diff with diff --no-indexJeff King, Jun 15, 2012
  3. 2/2 do not run pager with diff --no-index --quietJeff King, Jun 15, 2012
  4. Junio C HamanoJun 15, 2012

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.