Re: [PATCH v6 2/2] cat-file: add mailmap support to --batch-check option

[Christian Couder <christian.couder@gmail.com>]

On Thu, Dec 1, 2022 at 4:55 PM Siddharth Asthana
<siddharthasthana31@gmail.com> wrote:

> diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt
> index f82d702d6b..81235c60a3 100644
> --- a/Documentation/git-cat-file.txt
> +++ b/Documentation/git-cat-file.txt
> @@ -91,26 +91,49 @@ OPTIONS
>  --batch::
>  --batch=<format>::
>         Print object information and contents for each object provided
> -       on stdin.  May not be combined with any other options or arguments
> -       except `--textconv` or `--filters`, in which case the input lines

Nit: here there were backticks around --textconv and --filters ...

> -       also need to specify the path, separated by whitespace.  See the
> -       section `BATCH OUTPUT` below for details.
> +       on stdin. May not be combined with any other options or arguments
> +       except --textconv, --filters, or --use-mailmap.

... but here there are no backticks anymore.

It would be better if backticks were used.

> +       +
> +       * When used with `--textconv` or `--filters`, the input lines

Here and below backticks are used which is good.

> +         must specify the path, separated by whitespace. See the section
> +         `BATCH OUTPUT` below for details.
> +       +
> +       * When used with `--use-mailmap`, for commit and tag objects, the
> +         contents part of the output shows the identities replaced using the
> +         mailmap mechanism, while the information part of the output shows
> +         the size of the object as if it actually recorded the replacement
> +         identities.
>
>  --batch-check::
>  --batch-check=<format>::
> -       Print object information for each object provided on stdin.  May
> -       not be combined with any other options or arguments except
> -       `--textconv` or `--filters`, in which case the input lines also
> -       need to specify the path, separated by whitespace.  See the
> -       section `BATCH OUTPUT` below for details.
> +       Print object information for each object provided on stdin. May not be
> +       combined with any other options or arguments except --textconv, --filters
> +       or --use-mailmap.

Here backticks are also missing.

> +       +
> +       * When used with `--textconv` or `--filters`, the input lines must
> +        specify the path, separated by whitespace. See the section
> +        `BATCH OUTPUT` below for details.
> +       +
> +       * When used with `--use-mailmap`, for commit and tag objects, the
> +         printed object information shows the size of the object as if the
> +         identities recorded in it were replaced by the mailmap mechanism.
>
>  --batch-command::
>  --batch-command=<format>::
>         Enter a command mode that reads commands and arguments from stdin. May
> -       only be combined with `--buffer`, `--textconv` or `--filters`. In the
> -       case of `--textconv` or `--filters`, the input lines also need to specify
> -       the path, separated by whitespace. See the section `BATCH OUTPUT` below
> -       for details.
> +       only be combined with `--buffer`, `--textconv`, `--use-mailmap` or
> +       `--filters`.

Here they are used which is good.

> +       +
> +       * When used with `--textconv` or `--filters`, the input lines must
> +         specify the path, separated by whitespace. See the section
> +         `BATCH OUTPUT` below for details.
> +       +
> +       * When used with `--use-mailmap`, for commit and tag objects, the
> +         `contents` command shows the identities replaced using the
> +         mailmap mechanism, while the `info` command shows the size
> +         of the object as if it actually recorded the replacement
> +         identities.

Thanks!