Commit 38cd5b6a authored by Lucy Mielke's avatar Lucy Mielke Committed by Ingo Molnar
Browse files

perf/x86/intel/pt: Fix kernel-doc comments 



Some parameters or return codes were either wrong or missing,
update them.

Signed-off-by: default avatarLucy Mielke <lucymielke@icloud.com>
Signed-off-by: default avatarIngo Molnar <mingo@kernel.org>
Link: https://lore.kernel.org/r/ZSOjQW3e2nJR4bAo@fedora.fritz.box
parent a56d5551

arch/x86/events/intel/pt.c

+6 −2
Original line number Diff line number Diff line
@@ -736,6 +736,7 @@ static bool topa_table_full(struct topa *topa) 
/**

 * topa_insert_pages() - create a list of ToPA tables

 * @buf:	PT buffer being initialized.

 * @cpu:	CPU on which to allocate.

 * @gfp:	Allocation flags.

 *

 * This initializes a list of ToPA tables with entries from
@@ -1207,8 +1208,11 @@ static void pt_buffer_fini_topa(struct pt_buffer *buf) 
/**

 * pt_buffer_init_topa() - initialize ToPA table for pt buffer

 * @buf:	PT buffer.

 * @size:	Total size of all regions within this ToPA.

 * @cpu:	CPU on which to allocate.

 * @nr_pages:	No. of pages to allocate.

 * @gfp:	Allocation flags.

 *

 * Return:	0 on success or error code.

 */

static int pt_buffer_init_topa(struct pt_buffer *buf, int cpu,

			       unsigned long nr_pages, gfp_t gfp)
@@ -1281,7 +1285,7 @@ static int pt_buffer_try_single(struct pt_buffer *buf, int nr_pages) 


/**

 * pt_buffer_setup_aux() - set up topa tables for a PT buffer

 * @cpu:	Cpu on which to allocate, -1 means current.

 * @event:	Performance event

 * @pages:	Array of pointers to buffer pages passed from perf core.

 * @nr_pages:	Number of pages in the buffer.

 * @snapshot:	If this is a snapshot/overwrite counter.