Subject: [PATCH v1 0/3] coding-style.rst: document BUG() and WARN() rules

From: David Hildenbrand <[email-masked]>
Date: Tue, 20 Sep 2022 14:22:59 +0200

As it seems to be rather unclear if/when to use BUG(), BUG_ON(),
VM_BUG_ON(), WARN_ON_ONCE(), ... let's try to document the result of a
recent discussion.

Details can be found in patch #1.

RFC -> v1:
* "coding-style.rst: document BUG() and WARN() rules ("do not crash the
   kernel")"
 -> Rephrase/extend according to John
 -> Add some details regarding the use of panic()
* powerpc/prom_init: drop PROM_BUG()
 -> Added
* "checkpatch: warn on usage of VM_BUG_ON() and other BUG variants"
 -> Warn on more variants

Cc: Linus Torvalds <[email-masked]>
Cc: Andrew Morton <[email-masked]>
Cc: Ingo Molnar <[email-masked]>
Cc: David Laight <[email-masked]>
Cc: Jonathan Corbet <[email-masked]>
Cc: Andy Whitcroft <[email-masked]>
Cc: Joe Perches <[email-masked]>
Cc: Dwaipayan Ray <[email-masked]>
Cc: Lukas Bulwahn <[email-masked]>
Cc: Baoquan He <[email-masked]>
Cc: Vivek Goyal <[email-masked]>
Cc: Dave Young <[email-masked]>
Cc: Jani Nikula <[email-masked]>
Cc: Michael Ellerman <[email-masked]>
Cc: Nicholas Piggin <[email-masked]>
Cc: Christophe Leroy <[email-masked]>

David Hildenbrand (3):
  coding-style.rst: document BUG() and WARN() rules ("do not crash the
    kernel")
  powerpc/prom_init: drop PROM_BUG()
  checkpatch: warn on usage of VM_BUG_ON() and other BUG variants

 Documentation/process/coding-style.rst | 61 ++++++++++++++++++++++++++
 arch/powerpc/kernel/prom_init.c        |  6 ---
 scripts/checkpatch.pl                  |  6 +--
 3 files changed, 64 insertions(+), 9 deletions(-)

-- 
2.37.3