From: Jeff King <peff@peff.net>
To: git@vger.kernel.org
Cc: Jacob Keller <jacob.keller@gmail.com>,
Christian Couder <christian.couder@gmail.com>
Subject: [PATCH v4 5/8] interpret-trailers: add --parse convenience option
Date: Tue, 15 Aug 2017 06:23:34 -0400 [thread overview]
Message-ID: <20170815102334.qc4w7akl44bti44x@sigill.intra.peff.net> (raw)
In-Reply-To: <20170815102254.knccmhgralfijwli@sigill.intra.peff.net>
The last few commits have added command line options that
can turn interpret-trailers into a parsing tool. Since
they'd most often be used together, let's provide a
convenient single option for callers to invoke this mode.
This is implemented as a callback rather than a boolean so
that its effect is applied immediately, as if those options
had been specified. Later options can then override them.
E.g.:
git interpret-trailers --parse --no-unfold
would work.
Let's also update the documentation to make clear that this
parsing mode behaves quite differently than the normal
"add trailers to the input" mode.
Signed-off-by: Jeff King <peff@peff.net>
---
Documentation/git-interpret-trailers.txt | 21 ++++++++++++++-------
builtin/interpret-trailers.c | 12 ++++++++++++
2 files changed, 26 insertions(+), 7 deletions(-)
diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt
index be948e8028..1df8aabf51 100644
--- a/Documentation/git-interpret-trailers.txt
+++ b/Documentation/git-interpret-trailers.txt
@@ -3,24 +3,27 @@ git-interpret-trailers(1)
NAME
----
-git-interpret-trailers - help add structured information into commit messages
+git-interpret-trailers - add or parse structured information in commit messages
SYNOPSIS
--------
[verse]
-'git interpret-trailers' [--in-place] [--trim-empty] [(--trailer <token>[(=|:)<value>])...] [<file>...]
+'git interpret-trailers' [options] [(--trailer <token>[(=|:)<value>])...] [<file>...]
+'git interpret-trailers' [options] [--parse] [<file>...]
DESCRIPTION
-----------
-Help adding 'trailers' lines, that look similar to RFC 822 e-mail
+Help parsing or adding 'trailers' lines, that look similar to RFC 822 e-mail
headers, at the end of the otherwise free-form part of a commit
message.
This command reads some patches or commit messages from either the
-<file> arguments or the standard input if no <file> is specified. Then
-this command applies the arguments passed using the `--trailer`
-option, if any, to the commit message part of each input file. The
-result is emitted on the standard output.
+<file> arguments or the standard input if no <file> is specified. If
+`--parse` is specified, the output consists of the parsed trailers.
+
+Otherwise, the this command applies the arguments passed using the
+`--trailer` option, if any, to the commit message part of each input
+file. The result is emitted on the standard output.
Some configuration variables control the way the `--trailer` arguments
are applied to each commit message and the way any existing trailer in
@@ -92,6 +95,10 @@ OPTIONS
Remove any whitespace-continuation in trailers, so that each
trailer appears on a line by itself with its full content.
+--parse::
+ A convenience alias for `--only-trailers --only-input
+ --unfold`.
+
CONFIGURATION VARIABLES
-----------------------
diff --git a/builtin/interpret-trailers.c b/builtin/interpret-trailers.c
index 922c3bad63..555111a078 100644
--- a/builtin/interpret-trailers.c
+++ b/builtin/interpret-trailers.c
@@ -16,6 +16,16 @@ static const char * const git_interpret_trailers_usage[] = {
NULL
};
+static int parse_opt_parse(const struct option *opt, const char *arg,
+ int unset)
+{
+ struct process_trailer_options *v = opt->value;
+ v->only_trailers = 1;
+ v->only_input = 1;
+ v->unfold = 1;
+ return 0;
+}
+
int cmd_interpret_trailers(int argc, const char **argv, const char *prefix)
{
struct process_trailer_options opts = PROCESS_TRAILER_OPTIONS_INIT;
@@ -27,6 +37,8 @@ int cmd_interpret_trailers(int argc, const char **argv, const char *prefix)
OPT_BOOL(0, "only-trailers", &opts.only_trailers, N_("output only the trailers")),
OPT_BOOL(0, "only-input", &opts.only_input, N_("do not apply config rules")),
OPT_BOOL(0, "unfold", &opts.unfold, N_("join whitespace-continued values")),
+ { OPTION_CALLBACK, 0, "parse", &opts, NULL, N_("set parsing options"),
+ PARSE_OPT_NOARG | PARSE_OPT_NONEG, parse_opt_parse },
OPT_STRING_LIST(0, "trailer", &trailers, N_("trailer"),
N_("trailer(s) to add")),
OPT_END()
--
2.14.1.352.ge5efb0d3f3
next prev parent reply other threads:[~2017-08-15 10:23 UTC|newest]
Thread overview: 68+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-08-09 12:21 [PATCH 0/5] make interpret-trailers useful for parsing Jeff King
2017-08-09 12:22 ` [PATCH 1/5] trailer: put process_trailers() options into a struct Jeff King
2017-08-09 12:24 ` [PATCH 2/5] interpret-trailers: add an option to show only the trailers Jeff King
2017-08-09 17:52 ` Stefan Beller
2017-08-09 17:55 ` Stefan Beller
2017-08-09 18:35 ` Jonathan Tan
2017-08-10 7:40 ` Jeff King
2017-08-09 12:24 ` [PATCH 3/5] interpret-trailers: add an option to show only existing trailers Jeff King
2017-08-09 18:18 ` Stefan Beller
2017-08-10 7:32 ` Jeff King
2017-08-10 17:27 ` Stefan Beller
2017-08-10 17:33 ` Jeff King
2017-08-10 17:38 ` Stefan Beller
2017-08-10 18:43 ` Junio C Hamano
2017-08-09 18:38 ` Jonathan Tan
2017-08-10 7:36 ` Jeff King
2017-08-09 12:25 ` [PATCH 4/5] interpret-trailers: add an option to normalize output Jeff King
2017-08-09 12:26 ` [PATCH 5/5] interpret-trailers: add --parse convenience option Jeff King
2017-08-09 18:20 ` Stefan Beller
2017-08-10 7:59 ` Jeff King
2017-08-09 17:19 ` [PATCH 0/5] make interpret-trailers useful for parsing Junio C Hamano
2017-08-10 7:04 ` Jacob Keller
2017-08-10 7:28 ` Jeff King
2017-08-10 18:42 ` Junio C Hamano
2017-08-13 19:03 ` Jacob Keller
2017-08-10 8:02 ` Jeff King
2017-08-10 8:03 ` [PATCH 1/5] trailer: put process_trailers() options into a struct Jeff King
2017-08-10 8:03 ` [PATCH 2/5] interpret-trailers: add an option to show only the trailers Jeff King
2017-08-10 8:03 ` [PATCH 3/5] interpret-trailers: add an option to show only existing trailers Jeff King
2017-08-10 8:03 ` [PATCH 4/5] interpret-trailers: add an option to normalize output Jeff King
2017-08-10 18:35 ` Stefan Beller
2017-08-10 18:37 ` Jeff King
2017-08-10 19:39 ` Christian Couder
2017-08-10 19:42 ` Jeff King
2017-08-10 20:26 ` Christian Couder
2017-08-10 19:44 ` Stefan Beller
2017-08-10 21:06 ` Christian Couder
2017-08-10 21:10 ` Jeff King
2017-08-10 23:02 ` Ramsay Jones
2017-08-10 23:10 ` Jeff King
2017-08-10 23:36 ` Ramsay Jones
2017-08-11 7:02 ` Christian Couder
2017-08-11 9:06 ` Jeff King
2017-08-11 19:02 ` Christian Couder
2017-08-10 8:03 ` [PATCH 5/5] interpret-trailers: add --parse convenience option Jeff King
2017-08-10 18:03 ` [PATCH 0/5] make interpret-trailers useful for parsing Jeff King
2017-08-10 18:03 ` [PATCH v3 1/5] trailer: put process_trailers() options into a struct Jeff King
2017-08-10 18:04 ` [PATCH v3 2/5] interpret-trailers: add an option to show only the trailers Jeff King
2017-08-10 18:28 ` Stefan Beller
2017-08-10 18:31 ` Jeff King
2017-08-10 18:49 ` Junio C Hamano
2017-08-10 18:04 ` [PATCH v3 3/5] interpret-trailers: add an option to show only existing trailers Jeff King
2017-08-10 18:04 ` [PATCH v3 4/5] interpret-trailers: add an option to normalize output Jeff King
2017-08-10 18:04 ` [PATCH v3 5/5] interpret-trailers: add --parse convenience option Jeff King
2017-08-10 18:35 ` [PATCH 0/5] make interpret-trailers useful for parsing Stefan Beller
2017-08-10 19:43 ` Junio C Hamano
2017-08-15 10:22 ` [PATCH v4 0/8] trailer parsing via interpret-trailers and %(trailers) Jeff King
2017-08-15 10:23 ` [PATCH v4 1/8] trailer: put process_trailers() options into a struct Jeff King
2017-08-15 10:23 ` [PATCH v4 2/8] interpret-trailers: add an option to show only the trailers Jeff King
2017-08-15 10:23 ` [PATCH v4 3/8] interpret-trailers: add an option to show only existing trailers Jeff King
2017-08-15 10:23 ` [PATCH v4 4/8] interpret-trailers: add an option to unfold values Jeff King
2017-08-15 10:23 ` Jeff King [this message]
2017-08-15 11:26 ` [PATCH v4 5/8] interpret-trailers: add --parse convenience option Martin Ågren
2017-08-16 8:20 ` Jeff King
2017-08-17 18:19 ` Martin Ågren
2017-08-15 10:23 ` [PATCH v4 6/8] pretty: move trailer formatting to trailer.c Jeff King
2017-08-15 10:24 ` [PATCH v4 7/8] t4205: refactor %(trailers) tests Jeff King
2017-08-15 10:25 ` [PATCH v4 8/8] pretty: support normalization options for %(trailers) Jeff King
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=20170815102334.qc4w7akl44bti44x@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=christian.couder@gmail.com \
--cc=git@vger.kernel.org \
--cc=jacob.keller@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).