On Wed, 31 Oct 2007 14:08:48 -0700 Stephen Hemminger wrote:
> Documentation updates for network interfaces.
>
> 1. Add doc for netif_napi_add
> 2. Remove doc for unused returns from netif_rx
> 3. Add doc for netif_receive_skb
>
> Signed-off-by: Stephen Hemminger <[EMAIL PROTECTED]>
>
> --- a/net/core/dev.c 2007-10-31 09:16:09.000000000 -0700
> +++ b/net/core/dev.c 2007-10-31 10:00:39.000000000 -0700
> @@ -2001,6 +1998,21 @@ out:
> }
> #endif
>
> +/**
> + * netif_receive_skb - process receive buffer from network
> + * @skb: buffer to process
> + *
> + * netif_receive_skb() is the main receive data processing function.
> + * It always succeeds. The buffer may be dropped during processing
> + * for congestion control or by the protocol layers.
> + *
> + * This function may only be called from softirq context and interrupts
> + * should be enabled.
> + *
> + * return values (usually ignored).
> + * NET_RX_SUCCESS (no congestion)
> + * NET_RX_DROP (packet was dropped)
For the 3 lines above, how about:
* Return values (usually ignored):
* NET_RX_SUCCESS: no congestion
* NET_RX_DROP: packet was dropped
only because they come out of kernel-doc badly, munged together like so:
return values (usually ignored). NET_RX_SUCCESS (no congestion)
NET_RX_DROP (packet was dropped)
> + */
> int netif_receive_skb(struct sk_buff *skb)
> {
> struct packet_type *ptype, *pt_prev;
>
Thanks for doing this patch.
---
~Randy
-
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to [EMAIL PROTECTED]
More majordomo info at http://vger.kernel.org/majordomo-info.html
