diff options
author | Viral Mehta <Viral.Mehta@lntinfotech.com> | 2010-03-17 10:01:17 -0400 |
---|---|---|
committer | Jiri Kosina <jkosina@suse.cz> | 2010-03-17 20:24:38 -0400 |
commit | a8d89807373f95f3f7637e3987710a4500a7a857 (patch) | |
tree | 8e55cbefe8f61c12d1db2429378c57e4f5471a40 /include/linux/kfifo.h | |
parent | 9c5fb19adbeabd269ace11ee2d916cbc0d9118e6 (diff) |
kfifo: fix kerneldoc for kfifo_avail and kfifo_in_locked
Function argument is not having "len" anywhere;
"len" is later used in kfifo_{in|out}.
So here, it would be appropriate to say,
it copies @n bytes and not @len
Signed-off-by: Viral Mehta <viral.mehta@lntinfotech.com>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>
Diffstat (limited to 'include/linux/kfifo.h')
-rw-r--r-- | include/linux/kfifo.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/include/linux/kfifo.h b/include/linux/kfifo.h index bc0fc795bd35..7eb6ec41f486 100644 --- a/include/linux/kfifo.h +++ b/include/linux/kfifo.h | |||
@@ -202,7 +202,7 @@ static inline __must_check unsigned int kfifo_avail(struct kfifo *fifo) | |||
202 | * @n: the length of the data to be added. | 202 | * @n: the length of the data to be added. |
203 | * @lock: pointer to the spinlock to use for locking. | 203 | * @lock: pointer to the spinlock to use for locking. |
204 | * | 204 | * |
205 | * This function copies at most @len bytes from the @from buffer into | 205 | * This function copies at most @n bytes from the @from buffer into |
206 | * the FIFO depending on the free space, and returns the number of | 206 | * the FIFO depending on the free space, and returns the number of |
207 | * bytes copied. | 207 | * bytes copied. |
208 | */ | 208 | */ |
@@ -228,7 +228,7 @@ static inline unsigned int kfifo_in_locked(struct kfifo *fifo, | |||
228 | * @n: the size of the destination buffer. | 228 | * @n: the size of the destination buffer. |
229 | * @lock: pointer to the spinlock to use for locking. | 229 | * @lock: pointer to the spinlock to use for locking. |
230 | * | 230 | * |
231 | * This function copies at most @len bytes from the FIFO into the | 231 | * This function copies at most @n bytes from the FIFO into the |
232 | * @to buffer and returns the number of copied bytes. | 232 | * @to buffer and returns the number of copied bytes. |
233 | */ | 233 | */ |
234 | static inline __must_check unsigned int kfifo_out_locked(struct kfifo *fifo, | 234 | static inline __must_check unsigned int kfifo_out_locked(struct kfifo *fifo, |