Branch

Commit

Hash : f8e7d8fd
Author :
Date : 2021-11-26T17:33:38

cli: support `help <command>` Support `help <command>` by re-invoking the command itself with the `--help` argument. This allows us to keep the help logic with the commands itself.

cli

A git-compatible command-line interface that uses libgit2.

Adding commands

Individual commands have a main-like top-level entrypoint. For example:
```
int cmd_help(int argc, char **argv)
```
Although this is the same signature as main, commands are not built as individual standalone executables, they’ll be linked into the main cli. (Though there may be an option for command executables to be built as standalone executables in the future.)
Commands are prototyped in cmd.h and added to main.c‘s list of commands (cli_cmds[]). Commands should be specified with their name, entrypoint and a brief description that can be printed in git help. This is done because commands are linked into the main cli.
Commands should accept a --help option that displays their help information. This will be shown when a user runs <command> --help and when a user runs help <command>.

Source

src/cli/README.md

# cli

A git-compatible command-line interface that uses libgit2.

## Adding commands

1. Individual commands have a `main`-like top-level entrypoint.  For example:

   ```c
   int cmd_help(int argc, char **argv)
   ```

   Although this is the same signature as `main`, commands are not built as
   individual standalone executables, they'll be linked into the main cli.
   (Though there may be an option for command executables to be built as
   standalone executables in the future.)

2. Commands are prototyped in `cmd.h` and added to `main.c`'s list of
   commands (`cli_cmds[]`).  Commands should be specified with their name,
   entrypoint and a brief description that can be printed in `git help`.
   This is done because commands are linked into the main cli.

3. Commands should accept a `--help` option that displays their help
   information.  This will be shown when a user runs `<command> --help` and
   when a user runs `help <command>`.

thodg/libgit2/src/cli/README.md

Commit

cli

Adding commands

Source

src/cli/README.md