git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH] builtin/log.c: prepend "RFC" on --rfc

From
Drew DeVault <sir@cmpwn.com>
Date
Aug 28, 2023, 12:50 UTC
Message-ID
<20230828125132.25144-1-sir@cmpwn.com>

Rather than replacing the configured subject prefix (either through the git config or command line) entirely with "RFC PATCH", this change prepends RFC to whatever subject prefix was already in use.

This is useful, for example, when a user is working on a repository that has a subject prefix considered to disambiguate patches:

	git config format.subjectPrefix 'PATCH my-project'

Prior to this change, formatting patches with --rfc would lose the 'my-project' information.

Signed-off-by: Drew DeVault <sir@cmpwn.com>
---
Implementation note: this introduces a small memory leak, but freeing it
requires a non-trivial amount of refactoring and some dubious choices
that I was not sure of for a small patch; and it seems like memory leaks
in this context are tolerated anyway from a perusal of the existing
code.
 Documentation/git-format-patch.txt |  6 +++---
 builtin/log.c                      | 15 ++++++++++++++-
 t/t4014-format-patch.sh            |  9 +++++++++
 3 files changed, 26 insertions(+), 4 deletions(-)
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 373b46fc0d..fdc52cf826 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -229,9 +229,9 @@ populated with placeholder text.
 	variable, or 64 if unconfigured.
 
 --rfc::
-	Alias for `--subject-prefix="RFC PATCH"`. RFC means "Request For
-	Comments"; use this when sending an experimental patch for
-	discussion rather than application.
+	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.
 
 -v <n>::
 --reroll-count=<n>::
diff --git a/builtin/log.c b/builtin/log.c
index db3a88bfe9..d986faebed 100644
--- a/builtin/log.c
+++ b/builtin/log.c
@@ -1476,9 +1476,22 @@ static int subject_prefix_callback(const struct option *opt, const char *arg,
 
 static int rfc_callback(const struct option *opt, const char *arg, int unset)
 {
+	int n;
+	char *prefix;
+	const char *prev;
+
 	BUG_ON_OPT_NEG(unset);
 	BUG_ON_OPT_ARG(arg);
-	return subject_prefix_callback(opt, "RFC PATCH", unset);
+
+	prev = ((struct rev_info *)opt->value)->subject_prefix;
+	assert(prev != NULL);
+	n = snprintf(NULL, 0, "RFC %s", prev);
+	assert(n > 0);
+	prefix = xmalloc(n + 1);
+	n = snprintf(prefix, n + 1, "RFC %s", prev);
+	assert(n > 0);
+
+	return subject_prefix_callback(opt, prefix, unset);
 }
 
 static int numbered_cmdline_opt = 0;
diff --git a/t/t4014-format-patch.sh b/t/t4014-format-patch.sh
index 3cf2b7a7fb..a7fe839683 100755
--- a/t/t4014-format-patch.sh
+++ b/t/t4014-format-patch.sh
@@ -1377,6 +1377,15 @@ test_expect_success '--rfc' '
 	test_cmp expect actual
 '
 
+test_expect_success '--rfc does not overwrite prefix' '
+	cat >expect <<-\EOF &&
+	Subject: [RFC PATCH foobar 1/1] header with . in it
+	EOF
+	git format-patch -n -1 --stdout --subject-prefix "PATCH foobar" --rfc >patch &&
+	grep ^Subject: patch >actual &&
+	test_cmp expect actual
+'
+
 test_expect_success '--from=ident notices bogus ident' '
 	test_must_fail git format-patch -1 --stdout --from=foo >patch
 '
-- 
2.42.0
Next: Jeff King
Message 1 of 7 in “builtin/log.c: prepend "RFC" on --rfc”
  1. builtin/log.c: prepend "RFC" on --rfcDrew DeVault, Aug 28, 2023
  2. Jeff KingAug 28, 2023
  3. Drew DeVaultAug 28, 2023
  4. Phillip WoodAug 28, 2023
  5. Jeff KingAug 28, 2023
  6. Junio C HamanoAug 28, 2023
  7. Junio C HamanoAug 28, 2023

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.