Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Dave Hansen <dave.hansen@linux.intel.com>
To:     linux-kernel@vger.kernel.org
Cc:     Dave Hansen <dave.hansen@linux.intel.com>,
        Jonathan Corbet <corbet@lwn.net>, Borislav Petkov <bp@suse.de>,
        Thomas Gleixner <tglx@linutronix.de>, x86@kernel.org,
        linux-doc@vger.kernel.org
Subject: [PATCH] [RFC] Documentation/process: Add testing section to tip handbook
Date:   Mon, 14 Mar 2022 11:35:52 -0700
Message-Id: <20220314183552.1446911-1-dave.hansen@linux.intel.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

From: Dave Hansen <dave.hansen@linux.intel.com>

The kernel has a wide variety of debugging options to help catch
and squash bugs.  However, new debugging is added all the time and
the existing options can be hard to find.

Add a list of debugging options which tip maintainers expect to be
used to test contributions.

This should make it easier for contributors to test their code and
find issues before submission.

Signed-off-by: Dave Hansen <dave.hansen@linux.intel.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Borislav Petkov <bp@suse.de>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: x86@kernel.org
Cc: linux-doc@vger.kernel.org
---
 Documentation/process/maintainer-tip.rst | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/Documentation/process/maintainer-tip.rst b/Documentation/process/maintainer-tip.rst
index c74f4a81588b..75f86b0f1cf0 100644
--- a/Documentation/process/maintainer-tip.rst
+++ b/Documentation/process/maintainer-tip.rst
@@ -437,6 +437,30 @@ in a private repository which allows interested people to easily pull the
 series for testing. The usual way to offer this is a git URL in the cover
 letter of the patch series.
 
+Testing
+^^^^^^^
+
+Code should be tested before submitting to the tip maintainers.  Anything
+other than minor changes should be built, booted and tested with the
+following set of comprehensive (and heavyweight) set of kernel debugging
+options enabled.
+
+	CONFIG_X86_DEBUG_FPU=y
+	CONFIG_LOCK_STAT=y
+	CONFIG_DEBUG_VM=y
+	CONFIG_DEBUG_VM_VMACACHE=y
+	CONFIG_DEBUG_VM_RB=y
+	CONFIG_DEBUG_SLAB=y
+	CONFIG_DEBUG_KMEMLEAK=y
+	CONFIG_DEBUG_PAGEALLOC=y
+	CONFIG_SLUB_DEBUG_ON=y
+	CONFIG_KMEMCHECK=y
+	CONFIG_DEBUG_OBJECTS_ENABLE_DEFAULT=y
+	CONFIG_GCOV_KERNEL=y
+	CONFIG_LOCKDEP=y
+	CONFIG_PROVE_LOCKING=y
+	CONFIG_SCHEDSTATS=y
+	CONFIG_VMLINUX_VALIDATION=y
 
 Coding style notes
 ------------------
-- 
2.34.0