Skip to contentSkip to conversation

perf/x86/intel/pt: fix doc warnings in pt.c

PATCH New Baokun Li 1 participant 1 message Jun 5, 2021

Subsystems (2)
lore
Share & tools
lore

Baokun Li

author
#0 lore raw

PATCH 1/1 perf/x86/intel/pt: fix doc warnings in pt.c

Fixes the following W=1 kernel build warning(s):

arch/x86/events/intel/pt.c:729: warning: Function parameter or
member 'cpu' not described in 'topa_insert_pages'
arch/x86/events/intel/pt.c:1196: warning: Function parameter or
member 'cpu' not described in 'pt_buffer_init_topa'
arch/x86/events/intel/pt.c:1196: warning: Function parameter or
member 'nr_pages' not described in 'pt_buffer_init_topa'
arch/x86/events/intel/pt.c:1196: warning: Excess
function parameter 'size' description in 'pt_buffer_init_topa'
arch/x86/events/intel/pt.c:1269: warning: Function parameter or
member 'event' not described in 'pt_buffer_setup_aux'
arch/x86/events/intel/pt.c:1269: warning: Excess
function parameter 'cpu' description in 'pt_buffer_setup_aux'

---
 arch/x86/events/intel/pt.c | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
arch/x86/events/intel/pt.c +4 -2
index 915847655c06..035752429cea 100644
@@ -718,6 +718,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, -1 means current.
  * @gfp:	Allocation flags.
  *
  * This initializes a list of ToPA tables with entries from
@@ -1188,7 +1189,8 @@ 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, -1 means current.
+ * @nr_pages:	Number of pages in the buffer.
  * @gfp:	Allocation flags.
  */
 static int pt_buffer_init_topa(struct pt_buffer *buf, int cpu,
@@ -1253,7 +1255,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:	The perf 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.
Signature · 1 line
2.31.1