From: Phillip Wood <phillip.wood123@gmail.com>
To: Junio C Hamano <gitster@pobox.com>, git@vger.kernel.org
Cc: Dragan Simic <dsimic@manjaro.org>
Subject: Re: [PATCH] format-patch: allow --rfc to optionally take a value, like --rfc=WIP
Date: Fri, 19 Apr 2024 15:09:54 +0100 [thread overview]
Message-ID: <9f846a3d-5244-43ec-b392-156665be0929@gmail.com> (raw)
In-Reply-To: <xmqqzftqnuxq.fsf@gitster.g>
Hi Junio
On 18/04/2024 23:54, Junio C Hamano wrote:
> With the "--rfc" option, we can tweak the "[PATCH]" (or whatever
> string specified with the "--subject-prefix" option, instead of
> "PATCH") that we prefix the title of the commit with into "[RFC
> PATCH]", but some projects may want "[rfc PATCH]". Adding a new
> option, e.g., "--rfc-lowercase", to support such need every time
> somebody wants to use different strings would lead to insanity of
> accumulating unbounded number of such options.
>
> Allow an optional value specified for the option, so that users can
> use "--rfc=rfc" (think of "--rfc" without value as a short-hand for
> "--rfc=RFC").
>
> This can of course be (ab)used to make the prefix "[WIP PATCH]" by
> passing "--rfc=WIP".
I think being able to customize the subject prefix in this way is a good
idea and makes it easy to say [RESEND PATCH program] with --rfc=RESEND
when format.subjectPrefix is set. We could add a separate option to as
"--rfc" already exists I think it is reasonable to extend it. (I'm also
not a good name for such an option would be "--subject-prefix-prefix"
kind of describes what it does but is far from ideal)
> - [--rfc] [--subject-prefix=<subject-prefix>]
> + [--rfc[=<rfc>]] [--subject-prefix=<subject-prefix>]
Nit: in the documentation we use "<rfc>" for the placeholder but in the
code we use "<extra>"
> ---rfc::
> - Prepends "RFC" to the subject prefix (producing "RFC PATCH" by
> - default). RFC means "Request For Comments"; use this when sending
> - an experimental patch for discussion rather than application.
> +--rfc[=<rfc>]::
> + Prepends the string _<rfc>_ (defaults to "RFC") to
> + the subject prefix. As the subject prefix defaults to
> + "PATCH", you'll get "RFC PATCH" by default.
> ++
> +RFC means "Request For Comments"; use this when sending
> +an experimental patch for discussion rather than application.
> +"--rfc=WIP" may also be a useful way to indicate that a patch
> +is not complete yet.
This reworded description is good
> const struct option builtin_format_patch_options[] = {
> OPT_CALLBACK_F('n', "numbered", &numbered, NULL,
> @@ -1932,7 +1944,9 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix)
> N_("mark the series as Nth re-roll")),
> OPT_INTEGER(0, "filename-max-length", &fmt_patch_name_max,
> N_("max length of output filename")),
> - OPT_BOOL(0, "rfc", &rfc, N_("use [RFC PATCH] instead of [PATCH]")),
> + OPT_CALLBACK_F(0, "rfc", &rfc, N_("extra"),
> + N_("add <extra> (default 'RFC') before 'PATCH'"),
> + PARSE_OPT_NONEG|PARSE_OPT_OPTARG, rfc_callback),
This is a change in behavior as it looks like we previously accepted
"--no-rfc" is that deliberate?
Best Wishes
Phillip
next prev parent reply other threads:[~2024-04-19 14:12 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-18 22:54 [PATCH] format-patch: allow --rfc to optionally take a value, like --rfc=WIP Junio C Hamano
2024-04-19 0:29 ` Dragan Simic
2024-04-19 14:09 ` Phillip Wood [this message]
2024-04-19 17:03 ` Junio C Hamano
2024-04-21 14:18 ` Dragan Simic
2024-04-19 18:00 ` Jeff King
2024-04-19 18:19 ` Junio C Hamano
2024-04-19 22:01 ` [PATCH v2] " Junio C Hamano
2024-04-21 15:41 ` Phillip Wood
2024-04-21 18:58 ` Junio C Hamano
2024-04-21 18:59 ` [PATCH v3 0/2] format-patch --rfc=WIP Junio C Hamano
2024-04-21 18:59 ` [PATCH v3 1/2] format-patch: allow --rfc to optionally take a value, like --rfc=WIP Junio C Hamano
2024-04-21 18:59 ` [PATCH v3 2/2] format-patch: "--rfc=-(WIP)" appends to produce [PATCH (WIP)] Junio C Hamano
2024-04-21 19:37 ` Dragan Simic
2024-04-24 10:17 ` Phillip Wood
2024-04-24 15:52 ` Dragan Simic
2024-04-23 17:52 ` [PATCH v4 0/2] format-patch --rfc=WIP Junio C Hamano
2024-04-23 17:52 ` [PATCH v4 1/2] format-patch: allow --rfc to optionally take a value, like --rfc=WIP Junio C Hamano
2024-04-24 10:16 ` Phillip Wood
2024-04-23 17:52 ` [PATCH v4 2/2] format-patch: "--rfc=-(WIP)" appends to produce [PATCH (WIP)] Junio C Hamano
2024-04-24 10:16 ` Phillip Wood
2024-04-24 15:25 ` Junio C Hamano
2024-04-24 16:34 ` Dragan Simic
2024-04-24 15:58 ` Dragan Simic
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=9f846a3d-5244-43ec-b392-156665be0929@gmail.com \
--to=phillip.wood123@gmail.com \
--cc=dsimic@manjaro.org \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=phillip.wood@dunelm.org.uk \
/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).