Re: [PATCH v3 2/3] Packet sniffer core framework

From: David Miller
Date: Mon Feb 23 2015 - 16:37:26 EST


From: Stathis Voukelatos <stathis.voukelatos@xxxxxxxxxx>
Date: Mon, 23 Feb 2015 14:26:21 +0000

> + spin_lock_irqsave(&priv->lock, flags);
> + /* Stop the hardware */
> + sch->stop(sch);
> + /* Set the new command pattern */
> + ret = sch->set_pattern(sch, skb->data, skb->len / 2);
> + /* Restart the hardware */
> + sch->start(sch);
> + spin_unlock_irqrestore(&priv->lock, flags);

These comments are excessive.

When someone calls ops->stop() what are they supposed to think the
thing does? Open a can of tuna? Mow the lawn? Wash the dishes? No,
it stops the thing. Everyone understands that and you don't have to
explicitly say it.

Saying "stop the hardware" does not add anything to the source code
that is not already implicitly there. They just take up space and
keep more useful information from being displayed at once on the
screen. Please remove all of these things.

Thanks.
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/