perf/x86/intel/pt: Cleanup kernel-doc comments
Subsystems (2)
PATCH 1/1 perf/x86/intel/pt: Cleanup kernel-doc comments
Some parameters or return codes were either wrong or missing, so I cleaned it up to the best of my knowledge.
If anything I did was wrong, please let me know!
--- arch/x86/events/intel/pt.c | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-)
arch/x86/events/intel/pt.c +6 -2
@@ -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.
Signature · 1 line
2.41.0
Ingo Molnar
AppliedQuoted 4 lines · Lucy Mielke
Some parameters or return codes were either wrong or missing, so I cleaned it up to the best of my knowledge.
If anything I did was wrong, please let me know!
Your updates look correct to me too, thanks!
Applied to tip:perf/core, for a v6.7 merge. I changed the title, because these are not 'cleanups', but kernel-doc fixes for documentation annotation bugs that generate incorrect/misleading documentation.
Thanks,
Ingo
[tip: perf/core] perf/x86/intel/pt: Fix kernel-doc comments
In reply to Lucy MielkeThe following commit has been merged into the perf/core branch of tip:
The following commit has been merged into the perf/core branch of tip:
Commit-ID: 38cd5b6a875adc877681faf8e3ad47fdbd6eceb5 Gitweb: https://git.kernel.org/tip/38cd5b6a875adc877681faf8e3ad47fdbd6eceb5 Author: Lucy Mielke <[email protected]> AuthorDate: Mon, 09 Oct 2023 08:54:54 +02:00 Committer: Ingo Molnar <[email protected]> CommitterDate: Mon, 09 Oct 2023 12:26:22 +02:00
perf/x86/intel/pt: Fix kernel-doc comments
Some parameters or return codes were either wrong or missing, update them.
--- arch/x86/events/intel/pt.c | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-)
arch/x86/events/intel/pt.c +6 -2
@@ -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 @@ out:/** * 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.