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

[PATCH] Add the possibility to specify a default help format

From
Vincent van Ravesteijn <vfr@lyx.org>
Date
Jun 6, 2012, 12:56 UTC
Message-ID
<1338987397-7376-1-git-send-email-vfr@lyx.org>

At the moment, the default help format (i.e. the format that is chosen if 'git help xxx' is called without a help format parameter) is defined by the switch to be 'man'. However, on different platforms the preferred format might differ. For example, on Windows there is no man viewer, so we would prefer html.

This patch adds the possibility to choose a default help format on compilation by defining DEFAULT_HELP_FORMAT. If it is not specified the default is still 'man'.

Signed-off-by: Vincent van Ravesteijn <vfr@lyx.org>
---
 builtin/help.c |    8 +++++++-
 1 files changed, 7 insertions(+), 1 deletions(-)
diff --git a/builtin/help.c b/builtin/help.c
index 43d3c84..536d4fd 100644
--- a/builtin/help.c
+++ b/builtin/help.c
@@ -12,6 +12,10 @@
 #include "column.h"
 #include "help.h"
 
+#ifndef DEFAULT_HELP_FORMAT
+#define DEFAULT_HELP_FORMAT "man"
+#endif
+
 static struct man_viewer_list {
 	struct man_viewer_list *next;
 	char name[FLEX_ARRAY];
@@ -445,7 +449,9 @@ int cmd_help(int argc, const char **argv, const char *prefix)
 	setup_git_directory_gently(&nongit);
 	git_config(git_help_config, NULL);
 
-	if (parsed_help_format != HELP_FORMAT_NONE)
+	if (parsed_help_format == HELP_FORMAT_NONE)
+		help_format = parse_help_format(DEFAULT_HELP_FORMAT);
+	else
 		help_format = parsed_help_format;
 
 	alias = alias_lookup(argv[0]);
-- 
1.7.9.msysgit.0
Next: Jeff King
Message 1 of 8 in “Add the possibility to specify a default help format”
  1. Add the possibility to specify a default help formatVincent van Ravesteijn, Jun 6, 2012
  2. Jeff KingJun 6, 2012
  3. Add the DEFAULT_HELP_FORMAT option to Makefilevfr@lyx.org, Jun 6, 2012
  4. Junio C HamanoJun 6, 2012
  5. Vincent van RavesteijnJun 6, 2012
  6. Junio C HamanoJun 6, 2012
  7. [PATCHv2] Add the possibility to specify a default help formatVincent van Ravesteijn, Jun 6, 2012
  8. Junio C HamanoJun 6, 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.