docs: ftrace: Clarify the RAM impact of buffer_size_kb
authorFrank A. Cancio Bello <frank@generalsoftwareinc.com>
Wed, 25 Dec 2019 00:06:05 +0000 (19:06 -0500)
committerJonathan Corbet <corbet@lwn.net>
Fri, 10 Jan 2020 17:51:34 +0000 (10:51 -0700)
commita65d634e63644d05a22f32e5f2e56dde4f7ee77b
treec5fa0a12b5e2845a74dab7d3727d4624a6116d41
parent6f7f8ef713a24ccea341a7f0cb92ef2b6b297f01
docs: ftrace: Clarify the RAM impact of buffer_size_kb

The current text could mislead the user into believing that the number
of pages allocated by each CPU ring buffer is calculated by the round
up of the division: buffer_size_kb / PAGE_SIZE.

Clarifies that a few extra pages may be allocated to accommodate buffer
management meta-data.

Suggested-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
Suggested-by: Joel Fernandes (Google) <joel@joelfernandes.org>
Reviewed-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
Reviewed-by: Joel Fernandes (Google) <joel@joelfernandes.org>
Signed-off-by: Frank A. Cancio Bello <frank@generalsoftwareinc.com>
Link: https://lore.kernel.org/r/6f33be5f3d60e5ffc061d8d2b329d3d3ccf22a8c.1577231751.git.frank@generalsoftwareinc.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/trace/ftrace.rst