mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: "Ahmed S. Darwish" <darwi@linutronix.de>
To: Clark Williams <clrkwllms@kernel.org>,
	Steven Rostedt <rostedt@goodmis.org>,
	Ingo Molnar <mingo@redhat.com>,
	Nathan Chancellor <nathan@kernel.org>,
	Nicolas Schier <nsc@kernel.org>
Cc: "Sebastian Andrzej Siewior" <bigeasy@linutronix.de>,
	"Frederic Weisbecker" <frederic@kernel.org>,
	"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
	"Jonathan Corbet" <corbet@lwn.net>,
	"John Ogness" <john.ogness@linutronix.de>,
	"Derek Barbosa" <debarbos@redhat.com>,
	"Zbigniew Jędrzejewski-Szmek" <zbyszek@amutable.com>,
	"Daan De Meyer" <daan.j.demeyer@gmail.com>,
	"Luca Boccassi" <luca.boccassi@gmail.com>,
	linux-rt-devel@lists.linux.dev, debian-kernel@lists.debian.org,
	linux-kbuild@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	"Ahmed S. Darwish" <darwi@linutronix.de>
Subject: [PATCH v1 10/10] kconfig: Introduce OVERLAY= for make checkconfig
Date: Fri,  6 Nov 2026 10:19:22 +0100	[thread overview]
Message-ID: <20261106091922.7560-11-darwi@linutronix.de> (raw)
In-Reply-To: <20261106091922.7560-1-darwi@linutronix.de>

For the kconfig checkconfig target, allow passing a rules overlay file
through an OVERLAY= parameter.  This is mostly intended for distribution
kernel packaging scripts, CI systems, and board support packages.

Document this parameter at the kernel's administration guide.

Note, the detailed overlay semantics are already explained at
Documentation/tools/kconfig_checker.rst

Signed-off-by: Ahmed S. Darwish <darwi@linutronix.de>
---
 Documentation/admin-guide/README.rst | 7 ++++++-
 scripts/kconfig/Makefile             | 6 ++++--
 2 files changed, 10 insertions(+), 3 deletions(-)

diff --git a/Documentation/admin-guide/README.rst b/Documentation/admin-guide/README.rst
index 77ffe4dcb85b..b62689bcda6b 100644
--- a/Documentation/admin-guide/README.rst
+++ b/Documentation/admin-guide/README.rst
@@ -263,7 +263,7 @@ The kconfig build system can validate the generated kernel ``.config``
 against a selected rules profile. Running ``make checkconfig`` prints
 usage information and the available profiles::
 
-  Usage: make RULES=<profile> checkconfig
+  Usage: make RULES=<profile> [OVERLAY=<overlay>] checkconfig
   Available RULES: preempt_rt
 
 For example, to validate the current configuration against the PREEMPT_RT
@@ -278,6 +278,11 @@ selected rules profile. Each diagnostic includes a severity, such as
 Apply the reported changes as needed and run ``make checkconfig`` again,
 against the same rules, until no relevant diagnostics remain.
 
+The ``OVERLAY=`` parameter specifies an overlay file whose rules overrides
+the built-in mainline profile selected by ``RULES=``. It is intended for
+distributions kernel packaging scripts, CI systems, and board support
+packages.
+
 For more information, see Documentation/tools/kconfig_checker.rst
 
 Compiling the kernel
diff --git a/scripts/kconfig/Makefile b/scripts/kconfig/Makefile
index d67a23730259..faaa8c16ab03 100644
--- a/scripts/kconfig/Makefile
+++ b/scripts/kconfig/Makefile
@@ -126,6 +126,8 @@ testconfig: $(obj)/conf
 clean-files += tests/.cache
 
 checkconfig := $(PYTHON3) -B $(srctree)/tools/kconfig-checker/check.py
+checkconfig_overlay = $(if $(OVERLAY),-o "$(OVERLAY)")
+
 list_checkconfig_rules =						\
 	echo -n >&2 "Available RULES: ";				\
 	$(checkconfig) list-rules >&2;					\
@@ -134,7 +136,7 @@ list_checkconfig_rules =						\
 PHONY += checkconfig
 checkconfig:
 	$(Q)if [ -z "$(RULES)" ]; then					\
-		echo >&2 "Usage: make RULES=<profile> checkconfig";	\
+		echo >&2 "Usage: make RULES=<profile> [OVERLAY=<overlay>] checkconfig"; \
 		$(list_checkconfig_rules);				\
 		exit 2;							\
 	fi
@@ -143,7 +145,7 @@ checkconfig:
 		$(list_checkconfig_rules);				\
 		exit 2;							\
 	fi
-	$(Q)$(checkconfig) check -r "$(RULES)" -c "$(KCONFIG_CONFIG)"
+	$(Q)$(checkconfig) check -r "$(RULES)" -c "$(KCONFIG_CONFIG)" $(checkconfig_overlay)
 
 # Help text used by make help
 help:
-- 
2.56.0


      parent reply	other threads:[~2026-11-06  9:20 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-06  9:19 [PATCH v1 00/10] tools: Introduce a kernel configuration checker Ahmed S. Darwish
2026-11-06  9:19 ` [PATCH v1 01/10] kconfig-checker: Add schema for rule files Ahmed S. Darwish
2026-11-06  9:19 ` [PATCH v1 02/10] kconfig-checker: Introduce PREEMPT_RT configuration rules Ahmed S. Darwish
2026-11-06  9:19 ` [PATCH v1 03/10] kconfig-checker: Add the configuration checker code Ahmed S. Darwish
2026-11-06  9:19 ` [PATCH v1 04/10] kconfig: Introduce checkconfig target Ahmed S. Darwish
2026-11-06  9:19 ` [PATCH v1 05/10] Documentation: Describe kconfig-checker usage and design Ahmed S. Darwish
2026-11-06  9:19 ` [PATCH v1 06/10] kconfig-checker: Split schema to support component reuse Ahmed S. Darwish
2026-11-06  9:19 ` [PATCH v1 07/10] kconfig-checker: Introduce overlays schema Ahmed S. Darwish
2026-11-06  9:19 ` [PATCH v1 08/10] kconfig-checker: Add support for rule overlays Ahmed S. Darwish
2026-11-06  9:19 ` [PATCH v1 09/10] Documentation: Describe kconfig-checker overlays Ahmed S. Darwish
2026-11-06  9:19 ` Ahmed S. Darwish [this message]

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=20261106091922.7560-11-darwi@linutronix.de \
    --to=darwi@linutronix.de \
    --cc=bigeasy@linutronix.de \
    --cc=clrkwllms@kernel.org \
    --cc=corbet@lwn.net \
    --cc=daan.j.demeyer@gmail.com \
    --cc=debarbos@redhat.com \
    --cc=debian-kernel@lists.debian.org \
    --cc=frederic@kernel.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=john.ogness@linutronix.de \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kbuild@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-rt-devel@lists.linux.dev \
    --cc=luca.boccassi@gmail.com \
    --cc=mingo@redhat.com \
    --cc=nathan@kernel.org \
    --cc=nsc@kernel.org \
    --cc=rostedt@goodmis.org \
    --cc=zbyszek@amutable.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

all inboxes | Powered by JetHome®