doc: mmiotrace.txt, buffer size control change
authorPekka Paalanen <pq@iki.fi>
Sat, 3 Jan 2009 19:09:27 +0000 (21:09 +0200)
committerIngo Molnar <mingo@elte.hu>
Sun, 15 Feb 2009 19:05:13 +0000 (20:05 +0100)
commitf9aa28adfc6a4b01268ebb6d88566cca8627905f
tree20890c68a824dbca558425878856d865e1d85ccf
parent6bc5c366b1a45ca18fba6851f62db5743b3f6db5
doc: mmiotrace.txt, buffer size control change

Impact: prevents confusing the user when buffer size is inadequate

The tracing framework offers a resizeable buffer, which mmiotrace uses
to record events. If the buffer is full, the following events will be
lost. Events should not be lost, so the documentation instructs the user
to increase the buffer size. The buffer size is set via a debugfs file.

Mmiotrace documentation was not updated the same time the debugfs file
was changed. The old file was tracing/trace_entries and first contained
the number of entries the buffer had space for, per cpu. Nowadays this
file is replaced with the file tracing/buffer_size_kb, which tells the
amount of memory reserved for the buffer, per cpu, in kilobytes.

Previously, a flag had to be toggled via the debugfs file
tracing/tracing_enabled when the buffer size was changed. This is no
longer necessary.

The mmiotrace documentation is updated to reflect the current state of
the tracing framework.

Signed-off-by: Pekka Paalanen <pq@iki.fi>
Signed-off-by: Steven Rostedt <srostedt@redhat.com>
Signed-off-by: Ingo Molnar <mingo@elte.hu>
Documentation/tracers/mmiotrace.txt