Re: [PATCH v14 15/34] PCI/AER: Update struct aer_err_info with kernel-doc formatting
From: dan.j.williams
Date: Thu Jan 15 2026 - 15:56:21 EST
Jonathan Cameron wrote:
> On Wed, 14 Jan 2026 12:20:36 -0600
> Terry Bowman <terry.bowman@xxxxxxx> wrote:
>
> > Update the existing 'struct aer_err_info' definition to use kernel-doc
> > formatting. Remove the inline comments to reduce noise and do not introduce
> > functional changes. This will improve readability and maintainability.
> >
> > Signed-off-by: Terry Bowman <terry.bowman@xxxxxxx>
> > Reviewed-by: Dan Williams <dan.j.williams@xxxxxxxxx>
> Hi Terry.
>
> I didn't check but I think kernel-doc script will complain
> about partial docs. Other than that possibly needing fixing with
> a trivial entry for __pad1
It does:
Warning: drivers/pci/pci.h:764 struct member '__pad1' not described in 'aer_err_info'
Warning: drivers/pci/pci.h:764 struct member '__pad2' not described in 'aer_err_info'
...those are the only warnings in this set. Btw, this is my hacky script for
checking for new kdoc errors introduced in a patch series. I assume the
0day robot has something similar. Maybe something to cleanup and
contribute to checkpatch:
KDOC=~/git/linux/scripts/kernel-doc
for p in $(stg series -A --noprefix)
do
echo KERNELDOC $p
stg goto $p >/dev/null
for i in $(stg files --bare $p)
do
# only show the new errors relative to the contents of
# the file in the previous commit
f1=$(mktemp)
if [ git show HEAD^:$i >$f1 2>/dev/null ]; then
f2=$(mktemp)
f3=$(mktemp)
$KDOC $f1 2>$f2 >/dev/null
$KDOC $i 2>$f3 >/dev/null
diff -u $f2 $f3
rm $f2 $f3
else
$KDOC $i 2>&1 1>/dev/null
fi
rm $f1
done
done