config-batch: create 'help' command

Tools that use the 'git config-batch' tool will want to know which commands
are available in the current Git version. Having a 'help' command assists
greatly to give a clear set of available commands and their versions.

Signed-off-by: Derrick Stolee <[email protected]>

Author: derrickstolee

Documentation/git-config-batch.adoc

@@ -38,6 +38,23 @@ unknown_command LF
 
 These are the commands that are currently understood:
 
+`help` version 1::
+	The `help` command lists the currently-available commands in
+	this version of Git. The output is multi-line, but the first
+	line provides the count of possible commands via `help count <N>`.
+	The next `<N>` lines are of the form `help <command> <version>`
+	to state that this Git version supports that `<command>` at
+	version `<version>`. Note that the same command may have multiple
+	available versions.
++
+Here is the currentl output of the help text at the latest version:
++
+------------
+help count 2
+help help 1
+help get 1
+------------
+
 `get` version 1::
 	The `get` command searches the config key-value pairs within a
 	given `<scope>` for values that match the fixed `<key>` and

builtin/config-batch.c

@@ -12,6 +12,7 @@ static const char *const builtin_config_batch_usage[] = {
 };
 
 #define UNKNOWN_COMMAND "unknown_command"
+#define HELP_COMMAND "help"
 #define GET_COMMAND "get"
 #define COMMAND_PARSE_ERROR "command_parse_error"
 
@@ -55,6 +56,9 @@ static int unknown_command(struct repository *repo UNUSED,
 	return emit_response(UNKNOWN_COMMAND, NULL);
 }
 
+static int help_command_1(struct repository *repo,
+			  int argc, const char **argv);
+
 enum value_match_mode {
 	MATCH_ALL,
 	MATCH_EXACT,
@@ -240,6 +244,11 @@ struct command {
 };
 
 static struct command commands[] = {
+	{
+		.name = HELP_COMMAND,
+		.fn = help_command_1,
+		.version = 1,
+	},
 	{
 		.name = GET_COMMAND,
 		.fn = get_command_1,
@@ -254,6 +263,30 @@ static struct command commands[] = {
 
 #define COMMAND_COUNT ((size_t)(sizeof(commands) / sizeof(*commands)))
 
+
+static int help_command_1(struct repository *repo UNUSED,
+			  int argc UNUSED, const char **argv UNUSED)
+{
+	struct strbuf fmt_str = STRBUF_INIT;
+
+	strbuf_addf(&fmt_str, "%"PRIuMAX, COMMAND_COUNT - 1);
+	emit_response(HELP_COMMAND, "count", fmt_str.buf, NULL);
+	strbuf_reset(&fmt_str);
+
+	for (size_t i = 0; i < COMMAND_COUNT; i++) {
+		/* Halt at unknown command. */
+		if (!commands[i].name[0])
+			break;
+
+		strbuf_addf(&fmt_str, "%d", commands[i].version);
+		emit_response(HELP_COMMAND, commands[i].name, fmt_str.buf, NULL);
+		strbuf_reset(&fmt_str);
+	}
+
+	strbuf_release(&fmt_str);
+	return 0;
+}
+
 /**
  * Process a single line from stdin and process the command.
  *

t/t1312-config-batch.sh

@@ -16,6 +16,19 @@ test_expect_success 'unknown_command' '
 	test_cmp expect out
 '
 
+test_expect_success 'help command' '
+	echo "help 1" >in &&
+
+	cat >expect <<-\EOF &&
+	help count 2
+	help help 1
+	help get 1
+	EOF
+
+	git config-batch >out <in &&
+	test_cmp expect out
+'
+
 test_expect_success 'failed to parse version' '
 	echo "bogus BAD_VERSION line of tokens" >in &&
 	test_must_fail git config-batch 2>err <in &&