All of lore.kernel.org
 help / color / mirror / Atom feed
From: Dave Hansen <dave.hansen@linux.intel.com>
To: linux-kernel@vger.kernel.org
Cc: patches@lists.linux.dev,Dave Hansen
	<dave.hansen@linux.intel.com>,corbet@lwn.net,bp@suse.de,tglx@linutronix.de,x86@kernel.org,linux-doc@vger.kernel.org
Subject: [PATCH] [v2] x86/configs: Add x86 debugging Kconfig fragment plus docs
Date: Thu, 31 Mar 2022 10:57:28 -0700	[thread overview]
Message-ID: <20220331175728.299103A0@davehans-spike.ostc.intel.com> (raw)


Changes from v1:

 * Add actual .config fragment instead of just documenting it
 * Note that these partially x86-specific, but the rest can be
   used to test all tip contributions.

--

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 Kconfig fragment with the 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
---

 b/Documentation/process/maintainer-tip.rst |   14 ++++++++++++++
 b/kernel/configs/x86_debug.config          |   17 +++++++++++++++++
 2 files changed, 31 insertions(+)

diff -puN Documentation/process/maintainer-tip.rst~0001-RFC-Documentation-process-Add-testing-section-to-tip Documentation/process/maintainer-tip.rst
--- a/Documentation/process/maintainer-tip.rst~0001-RFC-Documentation-process-Add-testing-section-to-tip	2022-03-31 10:52:55.718665861 -0700
+++ b/Documentation/process/maintainer-tip.rst	2022-03-31 10:52:55.722665862 -0700
@@ -437,6 +437,20 @@ in a private repository which allows int
 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
+comprehensive (and heavyweight) kernel debugging options enabled.
+
+These debugging options can be found in kernel/configs/x86_debug.config
+and can be added to an existing kernel config by running:
+
+	make x86_debug.config
+
+Some of these options are x86-specific and can be left out when testing
+on other architectures.
 
 Coding style notes
 ------------------
diff -puN /dev/null kernel/configs/x86_debug.config
--- /dev/null	2022-03-26 18:22:40.487999538 -0700
+++ b/kernel/configs/x86_debug.config	2022-03-31 10:53:10.318671042 -0700
@@ -0,0 +1,17 @@
+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=y
+CONFIG_DEBUG_OBJECTS_ENABLE_DEFAULT=1
+CONFIG_GCOV_KERNEL=y
+CONFIG_LOCKDEP=y
+CONFIG_PROVE_LOCKING=y
+CONFIG_SCHEDSTATS=y
+CONFIG_VMLINUX_VALIDATION=y
_

WARNING: multiple messages have this Message-ID (diff)
From: Dave Hansen <dave.hansen@linux.intel.com>
To: linux-kernel@vger.kernel.org
Cc: patches@lists.linux.dev,
	Dave Hansen <dave.hansen@linux.intel.com>,
	corbet@lwn.net, bp@suse.de, tglx@linutronix.de, x86@kernel.org,
	linux-doc@vger.kernel.org
Subject: [PATCH] [v2] x86/configs: Add x86 debugging Kconfig fragment plus docs
Date: Thu, 31 Mar 2022 10:57:28 -0700	[thread overview]
Message-ID: <20220331175728.299103A0@davehans-spike.ostc.intel.com> (raw)


Changes from v1:

 * Add actual .config fragment instead of just documenting it
 * Note that these partially x86-specific, but the rest can be
   used to test all tip contributions.

--

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 Kconfig fragment with the 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
---

 b/Documentation/process/maintainer-tip.rst |   14 ++++++++++++++
 b/kernel/configs/x86_debug.config          |   17 +++++++++++++++++
 2 files changed, 31 insertions(+)

diff -puN Documentation/process/maintainer-tip.rst~0001-RFC-Documentation-process-Add-testing-section-to-tip Documentation/process/maintainer-tip.rst
--- a/Documentation/process/maintainer-tip.rst~0001-RFC-Documentation-process-Add-testing-section-to-tip	2022-03-31 10:52:55.718665861 -0700
+++ b/Documentation/process/maintainer-tip.rst	2022-03-31 10:52:55.722665862 -0700
@@ -437,6 +437,20 @@ in a private repository which allows int
 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
+comprehensive (and heavyweight) kernel debugging options enabled.
+
+These debugging options can be found in kernel/configs/x86_debug.config
+and can be added to an existing kernel config by running:
+
+	make x86_debug.config
+
+Some of these options are x86-specific and can be left out when testing
+on other architectures.
 
 Coding style notes
 ------------------
diff -puN /dev/null kernel/configs/x86_debug.config
--- /dev/null	2022-03-26 18:22:40.487999538 -0700
+++ b/kernel/configs/x86_debug.config	2022-03-31 10:53:10.318671042 -0700
@@ -0,0 +1,17 @@
+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=y
+CONFIG_DEBUG_OBJECTS_ENABLE_DEFAULT=1
+CONFIG_GCOV_KERNEL=y
+CONFIG_LOCKDEP=y
+CONFIG_PROVE_LOCKING=y
+CONFIG_SCHEDSTATS=y
+CONFIG_VMLINUX_VALIDATION=y
_

             reply	other threads:[~2022-03-31 17:57 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-31 17:57 Dave Hansen [this message]
2022-03-31 17:57 ` [PATCH] [v2] x86/configs: Add x86 debugging Kconfig fragment plus docs Dave Hansen
2022-04-01 17:57 ` Borislav Petkov
2022-04-05 20:01 ` [tip: x86/build] " tip-bot2 for Dave Hansen
2022-04-06 16:55   ` Nathan Chancellor
2022-04-06 17:59     ` Borislav Petkov
2022-04-06 18:01 ` tip-bot2 for Dave Hansen

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=20220331175728.299103A0@davehans-spike.ostc.intel.com \
    --to=dave.hansen@linux.intel.com \
    --cc=bp@suse.de \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=patches@lists.linux.dev \
    --cc=tglx@linutronix.de \
    --cc=x86@kernel.org \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.