mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	"Rafael J. Wysocki" <rafael@kernel.org>
Subject: [PATCH v2 6/6] drivers: base/node.c: fixes a kernel-doc markups
Date: Tue, 18 Jun 2019 15:55:12 -0300	[thread overview]
Message-ID: <bfda4a23dfd4b14d71d9622acd4e81d178f5bca3.1560884037.git.mchehab+samsung@kernel.org> (raw)
In-Reply-To: <2ff9c819831995ec34a826d44f9fae87ea3bf8c9.1560883872.git.mchehab+samsung@kernel.org>

There was a typo at the name of the vars inside the kernel-doc
comment, causing those warnings:

	./drivers/base/node.c:690: warning: Function parameter or member 'mem_nid' not described in 'register_memory_node_under_compute_node'
	./drivers/base/node.c:690: warning: Function parameter or member 'cpu_nid' not described in 'register_memory_node_under_compute_node'
	./drivers/base/node.c:690: warning: Excess function parameter 'mem_node' description in 'register_memory_node_under_compute_node'
	./drivers/base/node.c:690: warning: Excess function parameter 'cpu_node' description in 'register_memory_node_under_compute_node'

There's also a description missing here:
	./drivers/base/node.c:78: warning: Function parameter or member 'hmem_attrs' not described in 'node_access_nodes'

Copy an existing description from another function call.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---

v2: Add a missing hunk solving the warning reported as line #78.

 drivers/base/node.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/drivers/base/node.c b/drivers/base/node.c
index 9be88fd05147..beec80649b33 100644
--- a/drivers/base/node.c
+++ b/drivers/base/node.c
@@ -66,6 +66,7 @@ static DEVICE_ATTR(cpulist, S_IRUGO, node_read_cpulist, NULL);
  * @dev:	Device for this memory access class
  * @list_node:	List element in the node's access list
  * @access:	The access class rank
+ * @hmem_attrs: Heterogeneous memory performance attributes
  */
 struct node_access_nodes {
 	struct device		dev;
@@ -673,8 +674,8 @@ int register_cpu_under_node(unsigned int cpu, unsigned int nid)
 /**
  * register_memory_node_under_compute_node - link memory node to its compute
  *					     node for a given access class.
- * @mem_node:	Memory node number
- * @cpu_node:	Cpu  node number
+ * @mem_nid:	Memory node number
+ * @cpu_nid:	Cpu  node number
  * @access:	Access class to register
  *
  * Description:
-- 
2.21.0



  reply	other threads:[~2019-06-18 18:55 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-06-18 18:51 [PATCH 1/6] docs: trace: fix a broken label Mauro Carvalho Chehab
2019-06-18 18:51 ` [PATCH 2/6] docs: trace: add a missing blank line Mauro Carvalho Chehab
2019-06-18 18:59   ` Steven Rostedt
2019-06-19 15:08   ` Masami Hiramatsu
2019-06-20 20:07   ` Jonathan Corbet
2019-06-18 18:51 ` [PATCH 3/6] lib: list_sort.c: add a blank line to avoid kernel-doc warnings Mauro Carvalho Chehab
2019-06-20 20:07   ` Jonathan Corbet
2019-06-18 18:51 ` [PATCH 4/6] time: hrtimer: use a bullet for the returns bullet list Mauro Carvalho Chehab
2019-06-20 20:02   ` Jonathan Corbet
2019-06-20 20:16     ` Mauro Carvalho Chehab
2019-06-23 10:32       ` Thomas Gleixner
2019-06-18 18:51 ` [PATCH 5/6] docs: signal: fix a kernel-doc markup Mauro Carvalho Chehab
2019-06-18 18:51 ` [PATCH 6/6] drivers: base/node.c: fixes a kernel-doc markups Mauro Carvalho Chehab
2019-06-18 18:55   ` Mauro Carvalho Chehab [this message]
2019-06-19 15:09 ` [PATCH 1/6] docs: trace: fix a broken label Masami Hiramatsu
2019-06-20 20:06 ` Jonathan Corbet

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=bfda4a23dfd4b14d71d9622acd4e81d178f5bca3.1560884037.git.mchehab+samsung@kernel.org \
    --to=mchehab+samsung@kernel.org \
    --cc=corbet@lwn.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@infradead.org \
    --cc=rafael@kernel.org \
    /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

all inboxes | Powered by JetHome®