diff mbox series

[2/3] legacy: add note about removing options

Message ID 7089fae3bfd220eb34bf1a19ad3f47ec6cae12ed.1616963387.git.yann.morin.1998@free.fr
State New
Headers show
Series legacy: drop options older than 5 years, make that the new rule (branch yem/drop-old-legacy) | expand

Commit Message

Yann E. MORIN March 28, 2021, 8:30 p.m. UTC
Legacy options might still be in use, for example as a legacy default
(e.g. as a string default, or as a choice default).

So, when we eventually remove legacy options, we must ensure they are
no longer used.

Add a small shell snippet to make that easy.

Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
---
 Config.in.legacy | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/Config.in.legacy b/Config.in.legacy
index 967b67e03e..dbf53e3586 100644
--- a/Config.in.legacy
+++ b/Config.in.legacy
@@ -6,7 +6,10 @@ 
 # This will make the transition for the user more convenient.
 #
 # When adding legacy symbols to this file, add them to the front. The oldest
-# symbols will be removed again after at least five years.
+# symbols will be removed again after at least five years. When removing symbols,
+# ensure there is nothing that still uses them (like legacy defaults):
+#   syms="$(git diff |sed -r -e '/^-config ([^[:space:]]+)$/!d; s//\1/')"
+#   for sym in ${syms}; do git --no-pager grep ${sym}; done
 #
 # The symbol should be copied as-is from the place where it was previously
 # defined, but the help text should be removed or replaced with something that