diff options
| author | Lai Jiangshan <laijs@cn.fujitsu.com> | 2008-12-07 21:58:08 -0500 |
|---|---|---|
| committer | Ingo Molnar <mingo@elte.hu> | 2008-12-08 07:54:05 -0500 |
| commit | 361b73d5c34f59c3fd107bb9dbe7a1fbff2c2517 (patch) | |
| tree | 46006aac1b49ad080b14b17b6311ceca0dccc0e9 /include/linux | |
| parent | 21bbecdaaef3a6acc19905ab88c0587817318870 (diff) | |
ring_buffer: fix comments
Impact: comments cleanup
fix incorrect comments for enum ring_buffer_type
Signed-off-by: Lai Jiangshan <laijs@cn.fujitsu.com>
Signed-off-by: Ingo Molnar <mingo@elte.hu>
Diffstat (limited to 'include/linux')
| -rw-r--r-- | include/linux/ring_buffer.h | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/include/linux/ring_buffer.h b/include/linux/ring_buffer.h index 1a350a847edd..d363467c8f13 100644 --- a/include/linux/ring_buffer.h +++ b/include/linux/ring_buffer.h | |||
| @@ -28,17 +28,19 @@ struct ring_buffer_event { | |||
| 28 | * size = 8 bytes | 28 | * size = 8 bytes |
| 29 | * | 29 | * |
| 30 | * @RINGBUF_TYPE_TIME_STAMP: Sync time stamp with external clock | 30 | * @RINGBUF_TYPE_TIME_STAMP: Sync time stamp with external clock |
| 31 | * array[0] = tv_nsec | 31 | * array[0] = tv_nsec |
| 32 | * array[1] = tv_sec | 32 | * array[1..2] = tv_sec |
| 33 | * size = 16 bytes | 33 | * size = 16 bytes |
| 34 | * | 34 | * |
| 35 | * @RINGBUF_TYPE_DATA: Data record | 35 | * @RINGBUF_TYPE_DATA: Data record |
| 36 | * If len is zero: | 36 | * If len is zero: |
| 37 | * array[0] holds the actual length | 37 | * array[0] holds the actual length |
| 38 | * array[1..(length+3)/4-1] holds data | 38 | * array[1..(length+3)/4] holds data |
| 39 | * size = 4 + 4 + length (bytes) | ||
| 39 | * else | 40 | * else |
| 40 | * length = len << 2 | 41 | * length = len << 2 |
| 41 | * array[0..(length+3)/4] holds data | 42 | * array[0..(length+3)/4-1] holds data |
| 43 | * size = 4 + length (bytes) | ||
| 42 | */ | 44 | */ |
| 43 | enum ring_buffer_type { | 45 | enum ring_buffer_type { |
| 44 | RINGBUF_TYPE_PADDING, | 46 | RINGBUF_TYPE_PADDING, |
