Re: [PATCH] net:ethernet:intel:Remove outdated fix me comment in the function,gb_acquire_swfw_sync_i210

From: Jeff Kirsher
Date: Mon Feb 09 2015 - 04:35:38 EST


On Mon, 2015-02-09 at 10:29 +0100, BjÃrn Mork wrote:
> Jeff Kirsher <jeffrey.t.kirsher@xxxxxxxxx> writes:
>
> > If you want to see Nick's patch, feel free to view his patch on
> > my queue tree:
> > https://git.kernel.org/cgit/linux/kernel/git/jkirsher/queue.git/
>
> which said:
> - s32 i = 0, timeout = 200; /* FIXME: find real value to use here */
> + s32 i = 0, timeout = 200;
>
>
> Comments like the one deleted by that patch do have some value in my
> opinion: They document that the constant is chosen arbitrarily and is
> not taken from some datasheet.
>
> Not a big deal, but leaving such comments, even if the value never
> ever
> changes, could save someone from trying to figure out where the heck
> you
> got that constant. And there's noone actually misinterpreting this
> comment as "something needs to be fixed here", is there? So the cost
> of
> leaving the comment is exactly zero.
>
> Just my .02 â. I'm not going to tell you how to maintain your driver,
> of course. At least I try not to :-)

I see your point and I will have Carolyn take look to see if the comment
should rather be changed to see if we can describe why the value and
remove the FIXME at the same time.

Attachment: signature.asc
Description: This is a digitally signed message part