Ything-RepoMirrors/libgit2
2
0
Fork 0
mirror of https://github.com/libgit2/libgit2.git synced 2026-01-25 11:06:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

cli: optionally show hidden options in usage

Browse Source 
Callers may wish to show all the options, even hidden ones, when showing
usage. In particular, showing generic help for the CLI should show
global options (those that are generally "hidden"). But showing help for
a particular command should keep them hidden. Instrument a mechanism to
deal with this.
This commit is contained in:
Edward Thomson
2024-10-21 14:53:20 +01:00
parent 7e3535cf4b
commit e1d44d9834
10 changed files with 44 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/cli/cmd_blame.c
View File

@@ -40,7 +40,7 @@ static const cli_opt_spec opts[] = {
static void print_help(void)
{
cli_opt_usage_fprint(stdout, PROGRAM_NAME, COMMAND_NAME, opts);
cli_opt_usage_fprint(stdout, PROGRAM_NAME, COMMAND_NAME, opts, 0);
printf("\n");
printf("Show the origin of each line of a file.\n");

2
src/cli/cmd_cat_file.c
View File

@@ -43,7 +43,7 @@ static const cli_opt_spec opts[] = {
static void print_help(void)
{
cli_opt_usage_fprint(stdout, PROGRAM_NAME, COMMAND_NAME, opts);
cli_opt_usage_fprint(stdout, PROGRAM_NAME, COMMAND_NAME, opts, 0);
printf("\n");
printf("Display the content for the given object in the repository.\n");

2
src/cli/cmd_clone.c
View File

@@ -46,7 +46,7 @@ static const cli_opt_spec opts[] = {
static void print_help(void)
{
cli_opt_usage_fprint(stdout, PROGRAM_NAME, COMMAND_NAME, opts);
cli_opt_usage_fprint(stdout, PROGRAM_NAME, COMMAND_NAME, opts, 0);
printf("\n");
printf("Clone a repository into a new directory.\n");

2
src/cli/cmd_config.c
View File

@@ -68,7 +68,7 @@ static const cli_opt_spec opts[] = {
static void print_help(void)
{
cli_opt_usage_fprint(stdout, PROGRAM_NAME, COMMAND_NAME, opts);
cli_opt_usage_fprint(stdout, PROGRAM_NAME, COMMAND_NAME, opts, 0);
printf("\n");
printf("Query and set configuration options.\n");

2
src/cli/cmd_hash_object.c
View File

@@ -36,7 +36,7 @@ static const cli_opt_spec opts[] = {
static void print_help(void)
{
cli_opt_usage_fprint(stdout, PROGRAM_NAME, COMMAND_NAME, opts);
cli_opt_usage_fprint(stdout, PROGRAM_NAME, COMMAND_NAME, opts, 0);
printf("\n");
printf("Compute the object ID for a given file and optionally write that file\nto the object database.\n");

4
src/cli/cmd_help.c
View File

@@ -25,7 +25,7 @@ static const cli_opt_spec opts[] = {
static int print_help(void)
{
cli_opt_usage_fprint(stdout, PROGRAM_NAME, COMMAND_NAME, opts);
cli_opt_usage_fprint(stdout, PROGRAM_NAME, COMMAND_NAME, opts, CLI_OPT_USAGE_SHOW_HIDDEN);
printf("\n");
printf("Display help information about %s. If a command is specified, help\n", PROGRAM_NAME);
@@ -39,7 +39,7 @@ static int print_commands(void)
{
const cli_cmd_spec *cmd;
cli_opt_usage_fprint(stdout, PROGRAM_NAME, NULL, cli_common_opts);
cli_opt_usage_fprint(stdout, PROGRAM_NAME, NULL, cli_common_opts, CLI_OPT_USAGE_SHOW_HIDDEN);
printf("\n");
printf("These are the %s commands available:\n\n", PROGRAM_NAME);

2
src/cli/cmd_index_pack.c
View File

@@ -38,7 +38,7 @@ static const cli_opt_spec opts[] = {
static void print_help(void)
{
cli_opt_usage_fprint(stdout, PROGRAM_NAME, COMMAND_NAME, opts);
cli_opt_usage_fprint(stdout, PROGRAM_NAME, COMMAND_NAME, opts, 0);
printf("\n");
printf("Indexes a packfile and writes the index to disk.\n");

2
src/cli/main.c
View File

@@ -82,7 +82,7 @@ int main(int argc, char **argv)
while (cli_opt_parser_next(&opt, &optparser)) {
if (!opt.spec) {
cli_opt_status_fprint(stderr, PROGRAM_NAME, &opt);
cli_opt_usage_fprint(stderr, PROGRAM_NAME, NULL, cli_common_opts);
cli_opt_usage_fprint(stderr, PROGRAM_NAME, NULL, cli_common_opts, CLI_OPT_USAGE_SHOW_HIDDEN);
ret = CLI_EXIT_USAGE;
goto done;
}

38
src/cli/opt_usage.c
View File

@@ -46,7 +46,8 @@ int cli_opt_usage_fprint(
FILE *file,
const char *command,
const char *subcommand,
const cli_opt_spec specs[])
const cli_opt_spec specs[],
unsigned int print_flags)
{
git_str usage = GIT_BUF_INIT, opt = GIT_BUF_INIT;
const cli_opt_spec *spec;
@@ -73,7 +74,8 @@ int cli_opt_usage_fprint(
next_choice = !!((spec + 1)->usage & CLI_OPT_USAGE_CHOICE);
if (spec->usage & CLI_OPT_USAGE_HIDDEN)
if ((spec->usage & CLI_OPT_USAGE_HIDDEN) &&
!(print_flags & CLI_OPT_USAGE_SHOW_HIDDEN))
continue;
if (choice)
@@ -140,7 +142,7 @@ int cli_opt_usage_error(
const cli_opt *invalid_opt)
{
cli_opt_status_fprint(stderr, PROGRAM_NAME, invalid_opt);
cli_opt_usage_fprint(stderr, PROGRAM_NAME, subcommand, specs);
cli_opt_usage_fprint(stderr, PROGRAM_NAME, subcommand, specs, 0);
return CLI_EXIT_USAGE;
}
@@ -150,12 +152,19 @@ int cli_opt_help_fprint(
{
git_str help = GIT_BUF_INIT;
const cli_opt_spec *spec;
bool required;
int error = 0;
/* Display required arguments first */
for (spec = specs; spec->type; ++spec) {
if (! (spec->usage & CLI_OPT_USAGE_REQUIRED) ||
(spec->usage & CLI_OPT_USAGE_HIDDEN))
if ((spec->usage & CLI_OPT_USAGE_HIDDEN) ||
(spec->type == CLI_OPT_TYPE_LITERAL))
continue;
required = ((spec->usage & CLI_OPT_USAGE_REQUIRED) ||
((spec->usage & CLI_OPT_USAGE_CHOICE) && required));
if (!required)
continue;
git_str_printf(&help, " ");
@@ -163,13 +172,22 @@ int cli_opt_help_fprint(
if ((error = print_spec_name(&help, spec)) < 0)
goto done;
git_str_printf(&help, ": %s\n", spec->help);
if (spec->help)
git_str_printf(&help, ": %s", spec->help);
git_str_printf(&help, "\n");
}
/* Display the remaining arguments */
for (spec = specs; spec->type; ++spec) {
if ((spec->usage & CLI_OPT_USAGE_REQUIRED) ||
(spec->usage & CLI_OPT_USAGE_HIDDEN))
if ((spec->usage & CLI_OPT_USAGE_HIDDEN) ||
(spec->type == CLI_OPT_TYPE_LITERAL))
continue;
required = ((spec->usage & CLI_OPT_USAGE_REQUIRED) ||
((spec->usage & CLI_OPT_USAGE_CHOICE) && required));
if (required)
continue;
git_str_printf(&help, " ");
@@ -177,8 +195,10 @@ int cli_opt_help_fprint(
if ((error = print_spec_name(&help, spec)) < 0)
goto done;
git_str_printf(&help, ": %s\n", spec->help);
if (spec->help)
git_str_printf(&help, ": %s", spec->help);
git_str_printf(&help, "\n");
}
if (git_str_oom(&help) ||

7
src/cli/opt_usage.h
View File

@@ -8,6 +8,10 @@
#ifndef CLI_opt_usage_h__
#define CLI_opt_usage_h__
typedef enum {
CLI_OPT_USAGE_SHOW_HIDDEN = (1 << 0),
} cli_opt_usage_flags;
/**
* Prints usage information to the given file handle.
*
@@ -21,7 +25,8 @@ int cli_opt_usage_fprint(
FILE *file,
const char *command,
const char *subcommand,
const cli_opt_spec specs[]);
const cli_opt_spec specs[],
unsigned int print_flags);
int cli_opt_usage_error(
const char *subcommand,