kfifo: document everywhere that size has to be power of two

On my first try using them I missed that the fifos need to be power of
two, resulting in a runtime bug.  Document that requirement everywhere
(and fix one grammar bug)

Signed-off-by: Andi Kleen <[email protected]>
Acked-by: Stefani Seibold <[email protected]>
Cc: Roland Dreier <[email protected]>
Cc: Dmitry Torokhov <[email protected]>
Cc: Andy Walls <[email protected]>
Cc: Vikram Dhillon <[email protected]>
Signed-off-by: Andrew Morton <[email protected]>
Signed-off-by: Linus Torvalds <[email protected]>
This commit is contained in:
Andi Kleen 2010-01-15 17:01:17 -08:00 • committed by Linus Torvalds
commit 5dab600e6a
2 changed files with 3 additions and 3 deletions

View file

@ -41,7 +41,7 @@ static void _kfifo_init(struct kfifo *fifo, void *buffer,
* kfifo_init - initialize a FIFO using a preallocated buffer
* @fifo: the fifo to assign the buffer
* @buffer: the preallocated buffer to be used.
* @size: the size of the internal buffer, this have to be a power of 2.
* @size: the size of the internal buffer, this has to be a power of 2.
*
*/
void kfifo_init(struct kfifo *fifo, void *buffer, unsigned int size)