Re: [PATCH v2 0/2] coding-style.rst: document BUG() and WARN() rules

[Jonathan Corbet]

David Hildenbrand <david@xxxxxxxxxx> writes:

> 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.
>
> v1 -> v2:
> * "coding-style.rst: document BUG() and WARN() rules ("do not crash the
>    kernel")"
>  -> Minor rephrasing / reference fix [John]
>  -> Compile fix [Akira]
> * "powerpc/prom_init: drop PROM_BUG()"
>  -> Dropped because it will go upstream via a different tree
> * "checkpatch: warn on usage of VM_BUG_ON() and other BUG variants"
>  -> Rephrase warning message and remove trailing period [John+Joe]
>
> 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

It seems we've talked ourselves out on this one, so I've gone ahead and
applied it.

Thanks,

jon