2022-09-20 13:32:18

by David Hildenbrand

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

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

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

2022-10-04 13:47:34

by Michael Ellerman

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

On Tue, 20 Sep 2022 14:22:59 +0200, David Hildenbrand wrote:
> 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
>
> [...]

Patch 2 applied to powerpc/next.

[2/3] powerpc/prom_init: drop PROM_BUG()
https://git.kernel.org/powerpc/c/c4167aec98524fa4511b3222303a758b532b6009

cheers