Re: [PATCH v1 3/3] checkpatch: warn on usage of VM_BUG_ON() and other BUG variants
From: John Hubbard <jhubbard@nvidia.com>
Date: 2022-09-23 02:21:14
Also in:
linux-doc, linux-mm, lkml
From: John Hubbard <jhubbard@nvidia.com>
Date: 2022-09-23 02:21:14
Also in:
linux-doc, linux-mm, lkml
On 9/22/22 19:11, Joe Perches wrote:
quoted
Should this be a separate patch? Adding a bunch of exceptions to the BUG() rules is a separate and distinct thing from adding VM_BUG_ON() and other *BUG*() variants to the mix.Not in my opinion.
OK, then. :)
quoted
quoted
my $msg_level = \&WARN; $msg_level = \&CHK if ($file); &{$msg_level}("AVOID_BUG", - "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); + "Do not crash the kernel unless it is unavoidable - use WARN_ON_ONCE & recovery code (if reasonable) rather than BUG() or variants.\n" . $herecurr);Here's a requested tweak, to clean up the output and fix punctuation: "Avoid crashing the kernel--use WARN_ON_ONCE() plus recovery code (if feasible) instead of BUG() or variants.\n" . $herecurr);Fixing punctuation here would be removing the trailing period as checkpatch only has periods for multi-sentence output messages.
OK, let's do that too.
And I think that "Do not crash" is a stronger statement than "Avoid crashing" so I prefer the original suggestion but it's not a big deal either way.
Yes, stronger wording is better. So how about this: "Do not crash the kernel unless it is absolutely unavoidable--use WARN_ON_ONCE() plus recovery code (if feasible) instead of BUG() or variants\n" . $herecurr); thanks, -- John Hubbard NVIDIA