linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Baokun Li <libaokun1@huawei.com>
To: <peterz@infradead.org>, <mingo@redhat.com>, <acme@kernel.org>,
	<mark.rutland@arm.com>, <alexander.shishkin@linux.intel.com>,
	<jolsa@redhat.com>, <namhyung@kernel.org>, <tglx@linutronix.de>,
	<bp@alien8.de>, <x86@kernel.org>, <hpa@zytor.com>,
	<linux-perf-users@vger.kernel.org>,
	<linux-kernel@vger.kernel.org>
Cc: <weiyongjun1@huawei.com>, <yuehaibing@huawei.com>,
	<yangjihong1@huawei.com>, <yukuai3@huawei.com>,
	<libaokun1@huawei.com>
Subject: [PATCH -next] perf/x86/intel/pt: fix doc warnings in pt.c
Date: Sat, 5 Jun 2021 14:37:41 +0800	[thread overview]
Message-ID: <20210605063741.687206-1-libaokun1@huawei.com> (raw)

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'

Signed-off-by: Baokun Li <libaokun1@huawei.com>
---
 arch/x86/events/intel/pt.c | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/arch/x86/events/intel/pt.c b/arch/x86/events/intel/pt.c
index 915847655c06..035752429cea 100644
--- a/arch/x86/events/intel/pt.c
+++ b/arch/x86/events/intel/pt.c
@@ -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.
-- 
2.31.1


                 reply	other threads:[~2021-06-05  6:28 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210605063741.687206-1-libaokun1@huawei.com \
    --to=libaokun1@huawei.com \
    --cc=acme@kernel.org \
    --cc=alexander.shishkin@linux.intel.com \
    --cc=bp@alien8.de \
    --cc=hpa@zytor.com \
    --cc=jolsa@redhat.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-perf-users@vger.kernel.org \
    --cc=mark.rutland@arm.com \
    --cc=mingo@redhat.com \
    --cc=namhyung@kernel.org \
    --cc=peterz@infradead.org \
    --cc=tglx@linutronix.de \
    --cc=weiyongjun1@huawei.com \
    --cc=x86@kernel.org \
    --cc=yangjihong1@huawei.com \
    --cc=yuehaibing@huawei.com \
    --cc=yukuai3@huawei.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).