Re: [PATCH v2] PCI/AER: Print error message as per the TODO

From: Bjorn Helgaas
Date: Wed Jun 05 2024 - 17:58:59 EST


On Wed, Jun 05, 2024 at 09:23:44PM +0000, Abhinav Jain wrote:
> Print the add device error in find_device_iter()
>
> Signed-off-by: Abhinav Jain <jain.abhinav177@xxxxxxxxx>
>
> PATCH v1 link : https://lore.kernel.org/all/20240415161055.8316-1-jain.abhinav177@xxxxxxxxx/
>
> Changes since v1:
> - Replaced pr_err() with pr_notice()
> - Removed unncessary whitespaces
> ---

Thanks for looking at this.

- It doesn't apply to -rc1 (the TODO message is missing). In PCI,
we normally apply patches on topic branches based on -rc1.

- The subject should be more specific so it makes sense all by
itself, e.g., "Log note if we find too many devices with errors"

- Add period at end of sentence in commit log.

- Move historical notes (v1 URL, changes since v1) below the "---"
line so they don't get included in the commit log.

- __func__ is not relevant here -- that's generally a debugging
thing. We can find the function by searching for the message
text. In cases like this, I'd rather have something that helps
identify a *device* that's related to the message, e.g., the
pci_dev in this case. So I'd suggest pci_err(dev, "...") here.

- I'd keep pci_err() instead of switching to pr_notice(). If we get
this message, we should re-think the way we collect this
information, so I want to hear about it.

> drivers/pci/pcie/aer.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/pci/pcie/aer.c b/drivers/pci/pcie/aer.c
> index 0e1ad2998116..8b820a74dd6b 100644
> --- a/drivers/pci/pcie/aer.c
> +++ b/drivers/pci/pcie/aer.c
> @@ -885,8 +885,8 @@ static int find_device_iter(struct pci_dev *dev, void *data)
> /* List this device */
> if (add_error_device(e_info, dev)) {
> /* We cannot handle more... Stop iteration */
> - pr_err("find_device_iter: Cannot handle more devices.
> - Stopping iteration");
> + pr_notice("%s: Cannot handle more devices - iteration stopped\n",
> + __func__);
> return 1;
> }
>
> --
> 2.34.1
>