From: Borislav Petkov <bp@alien8.de>
To: Jonathan Corbet <corbet@lwn.net>
Cc: x86-ml <x86@kernel.org>, lkml <linux-kernel@vger.kernel.org>
Subject: [PATCH] Documentation/submitting-patches: Add blurb about backtraces in commit messages
Date: Tue, 22 Dec 2020 14:05:55 +0100 [thread overview]
Message-ID: <20201222130555.GA13463@zn.tnic> (raw)
In-Reply-To: <20201221095425.6da68163@lwn.net>
On Mon, Dec 21, 2020 at 09:54:25AM -0700, Jonathan Corbet wrote:
> Given that there was indeed a lack of bikeshedding, I just went ahead
> and applied this to docs-next; will ship it Linusward in the near
> future.
Cool.
Although I betcha that is because of the impending holiday season. I
think I should just use that moment to sneak in more stuff stealthily
and when everyone awakes from their drunken and food stupor, it'll all
be there! Tadaa!
:-)))
Ok, here's the next one which I think, is also, not really controversial.
Thx.
---
From: Borislav Petkov <bp@suse.de>
Date: Tue, 22 Dec 2020 13:58:22 +0100
Document that backtraces in commit messages should be trimmed down to
the useful information only.
This has been carved out from a tip subsystem handbook patchset by
Thomas Gleixner:
https://lkml.kernel.org/r/20181107171010.421878737@linutronix.de
and incorporates follow-on comments.
Signed-off-by: Borislav Petkov <bp@suse.de>
---
Documentation/process/submitting-patches.rst | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
index 5ba54120bef7..0ffb21366381 100644
--- a/Documentation/process/submitting-patches.rst
+++ b/Documentation/process/submitting-patches.rst
@@ -679,6 +679,26 @@ generates appropriate diffstats by default.)
See more details on the proper patch format in the following
references.
+Backtraces in commit mesages
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Backtraces help document the call chain leading to a problem. However,
+not all backtraces are helpful. For example, early boot call chains are
+unique and obvious. Copying the full dmesg output verbatim, however,
+adds distracting information like timestamps, module lists, register and
+stack dumps.
+
+Therefore, the most useful backtraces should distill the relevant
+information from the dump, which makes it easier to focus on the real
+issue. Here is an example of a well-trimmed backtrace::
+
+ unchecked MSR access error: WRMSR to 0xd51 (tried to write 0x0000000000000064)
+ at rIP: 0xffffffffae059994 (native_write_msr+0x4/0x20)
+ Call Trace:
+ mba_wrmsr
+ update_domains
+ rdtgroup_mkdir
+
.. _explicit_in_reply_to:
Explicit In-Reply-To headers
--
2.29.2
--
Regards/Gruss,
Boris.
https://people.kernel.org/tglx/notes-about-netiquette
next prev parent reply other threads:[~2020-12-22 13:06 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-12-17 18:37 [PATCH] Documentation/submitting-patches: Document the SoB chain Borislav Petkov
2020-12-21 16:54 ` Jonathan Corbet
2020-12-22 13:05 ` Borislav Petkov [this message]
2020-12-22 18:59 ` [PATCH] Documentation/submitting-patches: Add blurb about backtraces in commit messages Sean Christopherson
2020-12-22 19:25 ` Borislav Petkov
2020-12-28 17:59 ` Sean Christopherson
2020-12-28 18:15 ` Borislav Petkov
2020-12-28 19:02 ` Sean Christopherson
2021-01-04 23:19 ` Jonathan Corbet
2021-01-05 10:48 ` Borislav Petkov
2021-02-02 15:43 ` Borislav Petkov
2021-02-04 21:20 ` Jonathan Corbet
2021-02-15 14:19 ` [PATCH] Documentation/submitting-patches: Extend commit message layout description Borislav Petkov
2021-02-25 11:40 ` Robert Richter
2021-03-01 22:10 ` Jonathan Corbet
2021-04-13 11:38 ` [PATCH] Documentation/submitting-patches: Document RESEND tag on patches Borislav Petkov
2021-04-13 21:02 ` Jonathan Corbet
2021-04-15 6:05 ` Borislav Petkov
2021-05-31 14:35 ` Borislav Petkov
2021-06-01 22:27 ` Jonathan Corbet
2021-06-01 22:31 ` Randy Dunlap
2021-06-01 22:37 ` Borislav Petkov
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=20201222130555.GA13463@zn.tnic \
--to=bp@alien8.de \
--cc=corbet@lwn.net \
--cc=linux-kernel@vger.kernel.org \
--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 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).