On Thu, Dec 14, 2023 at 08:58:49AM +0800, Ethan Zhao wrote:
On 12/13/2023 6:49 PM, Lukas Wunner wrote:Much better.
On Tue, Dec 12, 2023 at 10:46:36PM -0500, Ethan Zhao wrote:Yup, why I made it public. then how about
move pci_dev_is_disconnected() from driver/pci/pci.h to publicThat's merely a prose description of the code. A reader can already
include/linux/pci.h for other driver's reference.
no function change.
see from the code what it's doing. You need to explain the *reason*
for the change instead. E.g.: "Make pci_dev_is_disconnected() public
so that it can be called from $DRIVER to speed up hot removal
handling which may otherwise take seconds because of $REASONS."
"Make pci_dev_is_disconnected() public so that it can be called from
Intel vt-d driver to check the device's hotplug removal state when
issue devTLB flush request."
You may optionally want to point out the location of the file in the
source tree because not everyone may be familiar where to find the
"Intel vt-d driver". Also, not every reader may know where issuing
of devTLB flush requests occurs, so it might make sense to name the
function where that happens. Finally, it is common to adhere to terms
used in the PCIe Base Spec in commit messages, so "ATC Invalidate Request"
might be preferable to "devTLB flush request".
Thanks,
Lukas