cmd_help.c 2.26 KB
Newer Older
1 2 3 4 5 6 7 8 9
/*
 * Copyright (C) the libgit2 contributors. All rights reserved.
 *
 * This file is part of libgit2, distributed under the GNU GPL v2 with
 * a Linking Exception. For full terms see the included COPYING file.
 */

#include <stdio.h>
#include <git2.h>
10
#include "common.h"
11 12 13 14 15 16 17 18
#include "cmd.h"

#define COMMAND_NAME "help"

static char *command;
static int show_help;

static const cli_opt_spec opts[] = {
Edward Thomson committed
19 20
	CLI_COMMON_OPT,

21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
	{ CLI_OPT_TYPE_ARG,      "command",  0, &command,   0,
	  CLI_OPT_USAGE_DEFAULT, "command", "the command to show help for" },
	{ 0 },
};

static int print_help(void)
{
	cli_opt_usage_fprint(stdout, PROGRAM_NAME, COMMAND_NAME, opts);
	printf("\n");

	printf("Display help information about %s.  If a command is specified, help\n", PROGRAM_NAME);
	printf("about that command will be shown.  Otherwise, general information about\n");
	printf("%s will be shown, including the commands available.\n", PROGRAM_NAME);

	return 0;
}

static int print_commands(void)
{
	const cli_cmd_spec *cmd;

	cli_opt_usage_fprint(stdout, PROGRAM_NAME, NULL, cli_common_opts);
	printf("\n");

	printf("These are the %s commands available:\n\n", PROGRAM_NAME);

	for (cmd = cli_cmds; cmd->name; cmd++)
48
		printf("   %-11s  %s\n", cmd->name, cmd->desc);
49 50 51 52 53 54 55 56

	printf("\nSee '%s help <command>' for more information on a specific command.\n", PROGRAM_NAME);

	return 0;
}

int cmd_help(int argc, char **argv)
{
57 58
	char *fake_args[2];
	const cli_cmd_spec *cmd;
59 60 61 62 63 64 65 66 67 68 69 70 71
	cli_opt invalid_opt;

	if (cli_opt_parse(&invalid_opt, opts, argv + 1, argc - 1, CLI_OPT_PARSE_GNU))
		return cli_opt_usage_error(COMMAND_NAME, opts, &invalid_opt);

	/* Show the meta-help */
	if (show_help)
		return print_help();

	/* We were not asked to show help for a specific command. */
	if (!command)
		return print_commands();

72 73 74 75 76 77 78 79 80 81 82 83
	/*
	 * If we were asked for help for a command (eg, `help <command>`),
	 * delegate back to that command's `--help` option.  This lets
	 * commands own their help.  Emulate the command-line arguments
	 * that would invoke `<command> --help` and invoke that command.
	 */
	fake_args[0] = command;
	fake_args[1] = "--help";

	if ((cmd = cli_cmd_spec_byname(command)) == NULL)
		return cli_error("'%s' is not a %s command. See '%s help'.",
		                command, PROGRAM_NAME, PROGRAM_NAME);
84

85
	return cmd->fn(2, fake_args);
86
}