git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: git@vger.kernel.org
Cc: Elijah Newren <newren@gmail.com>
Subject: [PATCH v4 1/6] you-still-use-that??: help deprecating commands for removal
Date: Mon, 12 May 2025 12:03:06 -0700	[thread overview]
Message-ID: <20250512190311.1451556-2-gitster@pobox.com> (raw)
In-Reply-To: <20250512190311.1451556-1-gitster@pobox.com>

Commands slated for removal like "git pack-redundant" now require
an explicit "--i-still-use-this" option to run.  This is to
discourage casual use and surface their pending deprecation to
users.

The warning message is long, so factor it into a helper function
you_still_use_that() to simplify reuse by other commands.

Also add a missing test to ensure this enforcement works for
"pack-redundant".

Helped-by: Elijah Newren <newren@gmail.com>
[en: log message]
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 builtin/pack-redundant.c  | 10 ++--------
 git-compat-util.h         |  2 ++
 t/t5323-pack-redundant.sh |  5 +++++
 usage.c                   | 12 ++++++++++++
 4 files changed, 21 insertions(+), 8 deletions(-)

diff --git a/builtin/pack-redundant.c b/builtin/pack-redundant.c
index 3febe732f8..6dc9e020c7 100644
--- a/builtin/pack-redundant.c
+++ b/builtin/pack-redundant.c
@@ -625,14 +625,8 @@ int cmd_pack_redundant(int argc, const char **argv, const char *prefix UNUSED, s
 			break;
 	}
 
-	if (!i_still_use_this) {
-		fputs(_("'git pack-redundant' is nominated for removal.\n"
-			"If you still use this command, please add an extra\n"
-			"option, '--i-still-use-this', on the command line\n"
-			"and let us know you still use it by sending an e-mail\n"
-			"to <git@vger.kernel.org>.  Thanks.\n"), stderr);
-		die(_("refusing to run without --i-still-use-this"));
-	}
+	if (!i_still_use_this)
+		you_still_use_that("git pack-redundant");
 
 	if (load_all_packs)
 		load_all();
diff --git a/git-compat-util.h b/git-compat-util.h
index e123288e8f..21cab99567 100644
--- a/git-compat-util.h
+++ b/git-compat-util.h
@@ -703,6 +703,8 @@ void warning_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
 
 void show_usage_if_asked(int ac, const char **av, const char *err);
 
+NORETURN void you_still_use_that(const char *command_name);
+
 #ifndef NO_OPENSSL
 #ifdef APPLE_COMMON_CRYPTO
 #include "compat/apple-common-crypto.h"
diff --git a/t/t5323-pack-redundant.sh b/t/t5323-pack-redundant.sh
index 688cd9706c..f2f20cfa40 100755
--- a/t/t5323-pack-redundant.sh
+++ b/t/t5323-pack-redundant.sh
@@ -45,6 +45,11 @@ fi
 main_repo=main.git
 shared_repo=shared.git
 
+test_expect_success 'pack-redundant needs --i-still-use-this' '
+	test_must_fail git pack-redundant >message 2>&1 &&
+	test_grep "nominated for removal" message
+'
+
 git_pack_redundant='git pack-redundant --i-still-use-this'
 
 # Create commits in <repo> and assign each commit's oid to shell variables
diff --git a/usage.c b/usage.c
index 38b46bbbfe..4aaad2b553 100644
--- a/usage.c
+++ b/usage.c
@@ -372,3 +372,15 @@ void bug_fl(const char *file, int line, const char *fmt, ...)
 	trace2_cmd_error_va(fmt, ap);
 	va_end(ap);
 }
+
+NORETURN void you_still_use_that(const char *command_name)
+{
+	fprintf(stderr,
+		_("'%s' is nominated for removal.\n"
+		  "If you still use this command, please add an extra\n"
+		  "option, '--i-still-use-this', on the command line\n"
+		  "and let us know you still use it by sending an e-mail\n"
+		  "to <git@vger.kernel.org>.  Thanks.\n"),
+		command_name);
+	die(_("refusing to run without --i-still-use-this"));
+}
-- 
2.49.0-674-gc1e4f99c0b


  reply	other threads:[~2025-05-12 19:03 UTC|newest]

Thread overview: 39+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-05-01 21:34 [PATCH 0/2] Nominating "whatchanged" for removal Junio C Hamano
2025-05-01 21:34 ` [PATCH 1/2] you-still-use-that??: help deprecating commands " Junio C Hamano
2025-05-01 21:34 ` [PATCH 2/2] whatchanged: require --i-still-use-this Junio C Hamano
2025-05-01 22:23   ` Junio C Hamano
2025-05-01 22:59 ` [PATCH v2 0/2] Nominating "whatchanged" for removal Junio C Hamano
2025-05-01 22:59   ` [PATCH v2 1/2] you-still-use-that??: help deprecating commands " Junio C Hamano
2025-05-01 22:59   ` [PATCH v2 2/2] whatchanged: require --i-still-use-this Junio C Hamano
2025-05-02  9:08     ` Patrick Steinhardt
2025-05-02 16:49       ` Junio C Hamano
2025-05-05  6:10         ` Patrick Steinhardt
2025-05-02  9:08   ` [PATCH v2 0/2] Nominating "whatchanged" for removal Patrick Steinhardt
2025-05-02 16:46     ` Junio C Hamano
2025-05-03  0:58   ` [PATCH v3 0/6] " Junio C Hamano
2025-05-03  0:58     ` [PATCH v3 1/6] you-still-use-that??: help deprecating commands " Junio C Hamano
2025-05-12 17:35       ` Elijah Newren
2025-05-03  0:58     ` [PATCH v3 2/6] doc: prepare for a world without whatchanged Junio C Hamano
2025-05-12 17:36       ` Elijah Newren
2025-05-03  0:58     ` [PATCH v3 3/6] tests: " Junio C Hamano
2025-05-05  6:56       ` Patrick Steinhardt
2025-05-12 17:36       ` Elijah Newren
2025-05-03  0:58     ` [PATCH v3 4/6] whatchanged: require --i-still-use-this Junio C Hamano
2025-05-05  6:56       ` Patrick Steinhardt
2025-05-05 20:49         ` Junio C Hamano
2025-05-03  0:58     ` [PATCH v3 5/6] whatchanged: remove when built with WITH_BREAKING_CHANGES Junio C Hamano
2025-05-05  6:56       ` Patrick Steinhardt
2025-05-05 20:57         ` Junio C Hamano
2025-05-03  0:58     ` [PATCH v3 6/6] whatschanged: list it in BreakingChanges document Junio C Hamano
2025-05-12 17:36       ` Elijah Newren
2025-05-12 18:35         ` Junio C Hamano
2025-05-12 19:03     ` [PATCH v4 0/6] Nominating "whatchanged" for removal Junio C Hamano
2025-05-12 19:03       ` Junio C Hamano [this message]
2025-05-12 19:03       ` [PATCH v4 2/6] doc: prepare for a world without whatchanged Junio C Hamano
2025-05-12 19:03       ` [PATCH v4 3/6] tests: " Junio C Hamano
2025-05-12 19:03       ` [PATCH v4 4/6] whatchanged: require --i-still-use-this Junio C Hamano
2025-05-14 13:38         ` Junio C Hamano
2025-05-12 19:03       ` [PATCH v4 5/6] whatchanged: remove when built with WITH_BREAKING_CHANGES Junio C Hamano
2025-05-12 19:03       ` [PATCH v4 6/6] whatschanged: list it in BreakingChanges document Junio C Hamano
2025-05-12 21:21       ` [PATCH v4 0/6] Nominating "whatchanged" for removal Elijah Newren
2025-05-12 22:42         ` Junio C Hamano

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

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

  git send-email \
    --in-reply-to=20250512190311.1451556-2-gitster@pobox.com \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=newren@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.
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 NNTP newsgroup(s).