Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit bc32383c authored by Mathias Krause's avatar Mathias Krause Committed by David S. Miller
Browse files

net: skbuff - kernel-doc fixes 



Use "@" to refer to parameters in the kernel-doc description. According
to Documentation/kernel-doc-nano-HOWTO.txt "&" shall be used to refer to
structures only.

Signed-off-by: default avatarMathias Krause <mathias.krause@secunet.com>
Cc: "David S. Miller" <davem@davemloft.net>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 253c6daa

include/linux/skbuff.h

+1 −1
Original line number Diff line number Diff line
@@ -1357,7 +1357,7 @@ static inline void __skb_fill_page_desc(struct sk_buff *skb, int i, 
 * @size: the length of the data

 *

 * As per __skb_fill_page_desc() -- initialises the @i'th fragment of

 * @skb to point to &size bytes at offset @off within @page. In

 * @skb to point to @size bytes at offset @off within @page. In

 * addition updates @skb such that @i is the last fragment.

 *

 * Does not take any additional reference on the fragment.

net/core/skbuff.c

+5 −5
Original line number Diff line number Diff line
@@ -1051,8 +1051,8 @@ EXPORT_SYMBOL(__pskb_copy); 
 *	@ntail: room to add at tail

 *	@gfp_mask: allocation priority

 *

 *	Expands (or creates identical copy, if &nhead and &ntail are zero)

 *	header of skb. &sk_buff itself is not changed. &sk_buff MUST have

 *	Expands (or creates identical copy, if @nhead and @ntail are zero)

 *	header of @skb. &sk_buff itself is not changed. &sk_buff MUST have

 *	reference count of 1. Returns zero in the case of success or error,

 *	if expansion failed. In the last case, &sk_buff is not changed.

 *
@@ -2563,14 +2563,14 @@ EXPORT_SYMBOL(skb_prepare_seq_read); 
 * @data: destination pointer for data to be returned

 * @st: state variable

 *

 * Reads a block of skb data at &consumed relative to the

 * Reads a block of skb data at @consumed relative to the

 * lower offset specified to skb_prepare_seq_read(). Assigns

 * the head of the data block to &data and returns the length

 * the head of the data block to @data and returns the length

 * of the block or 0 if the end of the skb data or the upper

 * offset has been reached.

 *

 * The caller is not required to consume all of the data

 * returned, i.e. &consumed is typically set to the number

 * returned, i.e. @consumed is typically set to the number

 * of bytes already consumed and the next call to

 * skb_seq_read() will return the remaining part of the block.

 *