mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Christian Couder <>
To: Siddharth Asthana <>
Subject: Re: [PATCH] doc/cat-file: allow --use-mailmap for --batch options
Date: Sat, 24 Sep 2022 16:49:59 +0200	[thread overview]
Message-ID: <> (raw)
In-Reply-To: <>

On Fri, Sep 23, 2022 at 9:36 PM Siddharth Asthana
<> wrote:
> The command git cat-file can now use the mailmap mechanism to replace
> idents with their canonical versions for commit and tag objects. There
> are several options like `--batch`, `--batch-check` and
> `--batch-command` that can be combined with `--use-mailmap`. But, the
> documentation for `--batch`, `--batch-check` and `--batch-command`
> doesn't say so. This patch fixes that documentation.
> Mentored-by: Christian Couder's avatarChristian Couder <>
> Mentored-by: John Cai's avatarJohn Cai <>

As you told me separately, you should remove "Christian Couder's
avatar" and "John Cai's avatar" from the above trailers.

> Signed-off-by: Siddharth Asthana <>
> ---

Here after the line that contains only '---' and before the short
stats below, you could write some small explanations about where this
patch comes from.

For example you could say that it was previously sent as the first
patch of a a 3 patch series:

And you could tell what changes you made compared to the previous patch.

>  Documentation/git-cat-file.txt | 44 ++++++++++++++++++++++++----------
>  1 file changed, 31 insertions(+), 13 deletions(-)
> diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt
> index ec30b5c574..3fdafc07ce 100644
> --- a/Documentation/git-cat-file.txt
> +++ b/Documentation/git-cat-file.txt
> @@ -89,26 +89,44 @@ 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
> -       also need to specify the path, separated by whitespace.  See the
> -       section `BATCH OUTPUT` below for details.
> +       on stdin.
> +
> +       * 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`, the info command shows the size
> +         the object, if the idents recorded in it were the ones "corrected"
> +         by the mailmap mechanism.
> +         Cannot be used with any other options.

Have you checked the result of `git help cat-file` after `make instll-doc`?

Shouldn't you use something like the following instead for additional
paragraphs inside some indented text:

* When used with `--textconv` or `--filters`, the input lines
must specify the path, separated by whitespace. See the section
`BATCH OUTPUT` below for details.


(Note that the + signs in what I suggest above should be actually
added to the file and aren't what a diff displays in front of new

Also it's not very clear if "Cannot be used with any other options."
is part of the last "* When ..." paragraph or not.

  reply	other threads:[~2022-09-24 14:51 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-23 19:35 [PATCH] doc/cat-file: allow --use-mailmap for --batch options Siddharth Asthana
2022-09-24 14:49 ` Christian Couder [this message]
2022-09-26  9:14 ` Siddharth Asthana
2022-09-26 14:11   ` John Cai
2022-10-21 10:32     ` Siddharth Asthana
2022-10-21 10:34 ` Siddharth Asthana
2022-10-21 18:56   ` Junio C Hamano
2022-10-29  9:25 ` Siddharth Asthana
2022-10-29 18:06   ` Taylor Blau
2022-10-30  7:06     ` Christian Couder
2022-10-30 18:07       ` Taylor Blau
2022-10-31 10:54   ` Christian Couder
2022-11-13 21:26     ` Siddharth Asthana

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:

  List information:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \ \ \ \ \ \ \

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).