From: Siddharth Asthana <siddharthasthana31@gmail.com>
To: git@vger.kernel.org
Cc: christian.couder@gmail.com, gitster@pobox.com,
johncai86@gmail.com,
Siddharth Asthana <siddharthasthana31@gmail.com>
Subject: [PATCH] doc/cat-file: allow --use-mailmap for --batch options
Date: Mon, 26 Sep 2022 14:44:42 +0530 [thread overview]
Message-ID: <20220926091442.222876-1-siddharthasthana31@gmail.com> (raw)
In-Reply-To: <20220923193543.58635-1-siddharthasthana31@gmail.com>
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 <christian.couder@gmail.com>
Mentored-by: John Cai <johncai86@gmail.com>
Signed-off-by: Siddharth Asthana <siddharthasthana31@gmail.com>
---
This patch was previously sent as the first patch of a 3 patch series for
adding the mailmap support in git cat-file options:
https://lore.kernel.org/git/20220916205946.178925-2-siddharthasthana31@gmail.com/
Changes in v2:
- Fixed the names in trailers in the commit message
- Updated the documentation to clearly state that the `--batch-check`,
`--batch-command` and `--batch` options can only be used with
`--textconv`, `--filters` or `--use-mailmap`.
- Fixed formating
Documentation/git-cat-file.txt | 45 ++++++++++++++++++++++++----------
1 file changed, 32 insertions(+), 13 deletions(-)
diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt
index ec30b5c574..2a8f050a29 100644
--- a/Documentation/git-cat-file.txt
+++ b/Documentation/git-cat-file.txt
@@ -89,26 +89,45 @@ 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. May not be combined with any other options or arguments
+ except --textconv, --filters or --use-mailmap.
+ +
+ * 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.
--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.
+ +
+ * 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.
--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`.
+ +
+ * 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.
+
+
`--batch-command` recognizes the following commands:
+
--
2.38.0.rc1.4.g29ac4cf309.dirty
next prev parent reply other threads:[~2022-09-26 9:18 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
2022-09-26 9:14 ` Siddharth Asthana [this message]
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:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220926091442.222876-1-siddharthasthana31@gmail.com \
--to=siddharthasthana31@gmail.com \
--cc=christian.couder@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=johncai86@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* 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
https://80x24.org/mirrors/git.git
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).