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

[PATCH v2 05/10] git.c: provide setup_auto_pager()

From
MÅMartin Ågren <martin.agren@gmail.com>
Date
Jul 17, 2017, 20:10 UTC
Message-ID
<b6ab825d3bda4b40201b0aa8e97c9fd721ed8171.1500321658.git.martin.agren@gmail.com>
In-Reply-To
<cover.1500321657.git.martin.agren@gmail.com>

The previous patch introduced a way for builtins to declare that they will take responsibility for handling the `pager.foo`-config item. (See the commit message of that patch for why that could be useful.)

Provide setup_auto_pager(), which builtins can call in order to handle `pager.<cmd>`, including possibly starting the pager. Make this function don't do anything if a pager has already been started, as indicated by use_pager or pager_in_use().

Whenever this function is called from a builtin, git.c will already have called commit_pager_choice(). Since commit_pager_choice() treats the special value -1 as "punt" or "not yet decided", it is not a problem that we might end up calling commit_pager_choice() once in git.c and once (or more) in the builtin. Make the new function use -1 in the same way and document it as "punt".

Don't add any users of setup_auto_pager just yet, one will follow in a later patch.

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
---
 builtin.h |  9 +++++++++
 git.c     | 10 ++++++++++
 2 files changed, 19 insertions(+)
diff --git a/builtin.h b/builtin.h
index 4186635de..3ca4a53a8 100644
--- a/builtin.h
+++ b/builtin.h
@@ -113,6 +113,15 @@ struct fmt_merge_msg_opts {
 extern int fmt_merge_msg(struct strbuf *in, struct strbuf *out,
 			 struct fmt_merge_msg_opts *);
 
+/**
+ * If a builtin has DELAY_PAGER_CONFIG set, the builtin should call this early
+ * when it wishes to respect the `pager.foo`-config. The `cmd` is the name of
+ * the builtin, e.g., "foo". If a paging-choice has already been setup, this
+ * does nothing. The default in `def` should be 0 for "pager off", 1 for "pager
+ * on" or -1 for "punt".
+ */
+extern void setup_auto_pager(const char *cmd, int def);
+
 extern int is_builtin(const char *s);
 
 extern int cmd_add(int argc, const char **argv, const char *prefix);
diff --git a/git.c b/git.c
index 79195ebbd..66832f232 100644
--- a/git.c
+++ b/git.c
@@ -33,6 +33,16 @@ static void commit_pager_choice(void) {
 	}
 }
 
+void setup_auto_pager(const char *cmd, int def)
+{
+	if (use_pager != -1 || pager_in_use())
+		return;
+	use_pager = check_pager_config(cmd);
+	if (use_pager == -1)
+		use_pager = def;
+	commit_pager_choice();
+}
+
 static int handle_options(const char ***argv, int *argc, int *envchanged)
 {
 	const char **orig_argv = *argv;
-- 
2.14.0.rc0
Previous: Martin ÅgrenNext: Jeff King
Message 33 of 69 in “tag: more fine-grained pager-configuration”
  1. 0/7 tag: more fine-grained pager-configurationMartin Ågren, Jul 10, 2017
  2. 1/7 api-builtin.txt: document SUPPORT_SUPER_PREFIXMartin Ågren, Jul 10, 2017
  3. Brandon WilliamsJul 10, 2017
  4. Martin ÅgrenJul 11, 2017
  5. Brandon WilliamsJul 11, 2017
  6. 2/7 git.c: let builtins opt for handling `pager.foo` themselvesMartin Ågren, Jul 10, 2017
  7. Jeff KingJul 11, 2017
  8. Martin ÅgrenJul 11, 2017
  9. Jeff KingJul 11, 2017
  10. 3/7 git.c: provide setup_auto_pager()Martin Ågren, Jul 10, 2017
  11. Jeff KingJul 11, 2017
  12. Martin ÅgrenJul 11, 2017
  13. 4/7 t7006: add tests for how git tag paginatesMartin Ågren, Jul 10, 2017
  14. 6/7 tag: make git tag -l consider new config `pager.tag.list`Martin Ågren, Jul 10, 2017
  15. Jeff KingJul 11, 2017
  16. Martin ÅgrenJul 11, 2017
  17. 5/7 tag: handle `pager.tag`-configuration within the builtinMartin Ågren, Jul 10, 2017
  18. Jeff KingJul 11, 2017
  19. 7/7 tag: make git tag -l use pager by defaultMartin Ågren, Jul 10, 2017
  20. Jeff KingJul 11, 2017
  21. Junio C HamanoJul 10, 2017
  22. Jeff KingJul 11, 2017
  23. Junio C HamanoJul 11, 2017
  24. Martin ÅgrenJul 12, 2017
  25. Jeff KingJul 11, 2017
  26. Martin ÅgrenJul 11, 2017
  27. Jeff KingJul 11, 2017
  28. 00/10 tag: only respect `pager.tag` in list-modeMartin Ågren, Jul 17, 2017
  29. 01/10 builtin.h: take over documentation from api-builtin.txtMartin Ågren, Jul 17, 2017
  30. 02/10 builtin.h: format documentation-comment properlyMartin Ågren, Jul 17, 2017
  31. 03/10 builtin.h: document SUPPORT_SUPER_PREFIXMartin Ågren, Jul 17, 2017
  32. 04/10 git.c: let builtins opt for handling `pager.foo` themselvesMartin Ågren, Jul 17, 2017
  33. 05/10 git.c: provide setup_auto_pager()Martin Ågren, Jul 17, 2017
  34. Jeff KingJul 31, 2017
  35. Junio C HamanoJul 31, 2017
  36. 06/10 t7006: add tests for how git tag paginatesMartin Ågren, Jul 17, 2017
  37. Jeff KingJul 31, 2017
  38. Junio C HamanoJul 31, 2017
  39. Martin ÅgrenJul 31, 2017
  40. 07/10 tag: handle `pager.tag`-configuration within the builtinMartin Ågren, Jul 17, 2017
  41. 08/10 tag: respect `pager.tag` in list-mode onlyMartin Ågren, Jul 17, 2017
  42. Jeff KingJul 31, 2017
  43. 09/10 tag: change default of `pager.tag` to "on"Martin Ågren, Jul 17, 2017
  44. 10/10 git.c: ignore pager.* when launching builtin as dashed externalMartin Ågren, Jul 17, 2017
  45. Jeff KingJul 31, 2017
  46. Martin ÅgrenJul 31, 2017
  47. Junio C HamanoJul 18, 2017
  48. Junio C HamanoJul 20, 2017
  49. Martin ÅgrenJul 23, 2017
  50. Jeff KingJul 31, 2017
  51. Martin ÅgrenJul 31, 2017
  52. Jeff KingJul 31, 2017
  53. Junio C HamanoJul 31, 2017
  54. 0/7 tag: only respect `pager.tag` in list-modeMartin Ågren, Aug 2, 2017
  55. 1/7 builtin.h: take over documentation from api-builtin.txtMartin Ågren, Aug 2, 2017
  56. Junio C HamanoAug 3, 2017
  57. Martin ÅgrenAug 4, 2017
  58. Junio C HamanoAug 4, 2017
  59. Martin ÅgrenAug 4, 2017
  60. 2/7 git.c: let builtins opt for handling `pager.foo` themselvesMartin Ågren, Aug 2, 2017
  61. 3/7 git.c: provide setup_auto_pager()Martin Ågren, Aug 2, 2017
  62. 4/7 t7006: add tests for how git tag paginatesMartin Ågren, Aug 2, 2017
  63. 5/7 tag: respect `pager.tag` in list-mode onlyMartin Ågren, Aug 2, 2017
  64. 6/7 tag: change default of `pager.tag` to "on"Martin Ågren, Aug 2, 2017
  65. 7/7 git.c: ignore pager.* when launching builtin as dashed externalMartin Ågren, Aug 2, 2017
  66. Junio C HamanoAug 3, 2017
  67. Jeff KingAug 3, 2017
  68. Martin ÅgrenAug 4, 2017
  69. Jeff KingAug 4, 2017

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.