[<prev] [next>] [<thread-prev] [day] [month] [year] [list]
Message-ID: <87fryea5zl.fsf@meer.lwn.net>
Date: Tue, 30 Jan 2024 14:03:42 -0700
From: Jonathan Corbet <corbet@....net>
To: Abhishek Pandit-Subedi <abhishekpandit@...omium.org>,
gregkh@...uxfoundation.org
Cc: Abhishek Pandit-Subedi <abhishekpandit@...omium.org>,
linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
workflows@...r.kernel.org
Subject: Re: [PATCH] coding-style: Add guidance to prefer dev_dbg
Abhishek Pandit-Subedi <abhishekpandit@...omium.org> writes:
> During review, it was suggested that drivers only emit messages when
> something is wrong or it is a debug message. Document this as a formal
> recommendation.
>
> https://lore.kernel.org/linux-usb/2024012525-alienate-frown-916b@gregkh/
>
> Signed-off-by: Abhishek Pandit-Subedi <abhishekpandit@...omium.org>
> ---
> I'm sending up the change to documentation while this is still fresh.
> Will send an update to checkpatch.pl afterwards.
>
> Documentation/process/coding-style.rst | 3 ++-
> 1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
> index c48382c6b477..f8ec23fa89bc 100644
> --- a/Documentation/process/coding-style.rst
> +++ b/Documentation/process/coding-style.rst
> @@ -899,7 +899,8 @@ which you should use to make sure messages are matched to the right device
> and driver, and are tagged with the right level: dev_err(), dev_warn(),
> dev_info(), and so forth. For messages that aren't associated with a
> particular device, <linux/printk.h> defines pr_notice(), pr_info(),
> -pr_warn(), pr_err(), etc.
> +pr_warn(), pr_err(), etc. When drivers are working properly they are quiet,
> +so prefer to use dev_dbg/pr_debug unless something is wrong.
>
Applied, thanks.
jon
Powered by blists - more mailing lists