Documentation: add a guideline for hard_start_xmit method
authorMatti Linnanvuori <mattilinnanvuori@yahoo.com>
Tue, 15 Jan 2008 14:25:27 +0000 (06:25 -0800)
committerJeff Garzik <jeff@garzik.org>
Fri, 18 Jan 2008 19:41:49 +0000 (14:41 -0500)
Add a guideline not to modify SKBs.

Signed-off-by: Matti Linnanvuori <mattilinnanvuori@yahoo.com>
Signed-off-by: Jeff Garzik <jeff@garzik.org>
Documentation/networking/driver.txt

index 4f7da5a..ea72d2e 100644 (file)
@@ -61,7 +61,10 @@ Transmit path guidelines:
 2) Do not forget to update netdev->trans_start to jiffies after
    each new tx packet is given to the hardware.
 
-3) Do not forget that once you return 0 from your hard_start_xmit
+3) A hard_start_xmit method must not modify the shared parts of a
+   cloned SKB.
+
+4) Do not forget that once you return 0 from your hard_start_xmit
    method, it is your driver's responsibility to free up the SKB
    and in some finite amount of time.