On Tue, Aug 27, 2024 at 10:48:25AM +0200, Maxime Chevallier wrote:

Hi again Dan,

On Tue, 27 Aug 2024 11:27:48 +0300
Dan Carpenter [off-list ref] wrote:

quoted

Could you add some comments to ethnl_req_get_phydev() what the NULL return
means vs the error pointers?  I figured it out because the callers have comments
but it should be next to ethnl_req_get_phydev() as well.

Actually I replied a bit too fast, this is already documented :
https://git.kernel.org/pub/scm/linux/kernel/git/netdev/net-next.git/tree/net/ethtool/netlink.h#n284

Is this doc clear enough or should I still add some more explicit
comments ?

Ah, I didn't see that.  Thanks.

That comment is fine but we normally would have put it next to the function
implementation instead of the header file.  There are lots of comments in the
header file, sure, but those are for inline functions so it's the same rule of
thumb that the comments are next to the implementation.

regards,
dan carpenter