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 <torva...@linux-foundation.org>
Cc: Andrew Morton <a...@linux-foundation.org>
Cc: Ingo Molnar <mi...@kernel.org>
Cc: David Laight <david.lai...@aculab.com>
Cc: Jonathan Corbet <cor...@lwn.net>
Cc: Andy Whitcroft <a...@canonical.com>
Cc: Joe Perches <j...@perches.com>
Cc: Dwaipayan Ray <dwaipayanr...@gmail.com>
Cc: Lukas Bulwahn <lukas.bulw...@gmail.com>
Cc: Baoquan He <b...@redhat.com>
Cc: Vivek Goyal <vgo...@redhat.com>
Cc: Dave Young <dyo...@redhat.com>
Cc: Jani Nikula <jani.nik...@linux.intel.com>
Cc: Michael Ellerman <m...@ellerman.id.au>
Cc: Nicholas Piggin <npig...@gmail.com>
Cc: Christophe Leroy <christophe.le...@csgroup.eu>
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
