From: "Steven Rostedt (Google)" <rostedt@xxxxxxxxxxx> The man page for tep_get_sub_buffer_size() is missing, add it. Signed-off-by: Steven Rostedt (Google) <rostedt@xxxxxxxxxxx> --- Documentation/libtraceevent-page_size.txt | 10 +++++++++- Documentation/libtraceevent.txt | 1 + 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/Documentation/libtraceevent-page_size.txt b/Documentation/libtraceevent-page_size.txt index 7ffeb790002a..6d0dd36e3d68 100644 --- a/Documentation/libtraceevent-page_size.txt +++ b/Documentation/libtraceevent-page_size.txt @@ -3,7 +3,7 @@ libtraceevent(3) NAME ---- -tep_get_page_size, tep_set_page_size - Get / set the size of a memory page on +tep_get_page_size, tep_set_page_size, tep_get_sub_buffer_size - Get / set the size of a memory page on the machine, where the trace is generated SYNOPSIS @@ -14,6 +14,7 @@ SYNOPSIS int *tep_get_page_size*(struct tep_handle pass:[*]_tep_); void *tep_set_page_size*(struct tep_handle pass:[*]_tep_, int _page_size_); +int *tep_get_sub_buffer_size*(struct tep_handle pass:[*]_tep_); -- DESCRIPTION @@ -27,10 +28,17 @@ memory page on the machine, where the trace is generated. The _tep_ argument is trace event parser context. The _page_size_ argument is the size of a memory page, in bytes. +The *tep_get_sub_buffer_size()* returns the size of each "sub buffer" of the +ring buffer. The Linux kernel ring buffer is broken up into sections called +sub buffers. This returns the size of those buffers. + RETURN VALUE ------------ The *tep_get_page_size()* function returns size of the memory page, in bytes. +The *tep_get_sub_buffer_size()* function returns the number of bytes each sub +buffer is made up of. + EXAMPLE ------- [source,c] diff --git a/Documentation/libtraceevent.txt b/Documentation/libtraceevent.txt index 045437cb2282..0d0795e79b53 100644 --- a/Documentation/libtraceevent.txt +++ b/Documentation/libtraceevent.txt @@ -26,6 +26,7 @@ Management of tep handler data structure and access of its members: void *tep_set_long_size*(struct tep_handle pass:[*]_tep_, int _long_size_); int *tep_get_page_size*(struct tep_handle pass:[*]_tep_); void *tep_set_page_size*(struct tep_handle pass:[*]_tep_, int _page_size_); + int *tep_get_sub_buffer_size*(struct tep_handle pass:[*]_tep_); int *tep_get_header_page_size*(struct tep_handle pass:[*]_tep_); int *tep_get_header_timestamp_size*(struct tep_handle pass:[*]_tep_); bool *tep_is_old_format*(struct tep_handle pass:[*]_tep_); -- 2.35.1
|