LKML Archive on lore.kernel.org
 help / color / Atom feed
From: Borislav Petkov <bp@suse.de>
To: rdunlap@infradead.org
Cc: linux-tip-commits@vger.kernel.org, akpm@linux-foundation.org,
	peterz@infradead.org, rdunlap@infradead.org,
	torvalds@linux-foundation.org, tglx@linutronix.de,
	mingo@kernel.org, hpa@zytor.com, linux-kernel@vger.kernel.org
Subject: Re: [tip:core/urgent] resource/docs: Fix new kernel-doc warnings
Date: Mon, 5 Nov 2018 10:33:07 +0100
Message-ID: <20181105093307.GA12445@zn.tnic> (raw)
In-Reply-To: <tip-f75d651587f719a813ebbbfeee570e6570731d55@git.kernel.org>

On Sun, Nov 04, 2018 at 10:09:50PM -0800, tip-bot for Randy Dunlap wrote:
> Commit-ID:  f75d651587f719a813ebbbfeee570e6570731d55
> Gitweb:     https://git.kernel.org/tip/f75d651587f719a813ebbbfeee570e6570731d55
> Author:     Randy Dunlap <rdunlap@infradead.org>
> AuthorDate: Sun, 4 Nov 2018 18:40:14 -0800
> Committer:  Ingo Molnar <mingo@kernel.org>
> CommitDate: Mon, 5 Nov 2018 07:05:04 +0100
> 
> resource/docs: Fix new kernel-doc warnings
> 
> The first group of warnings is caused by a "/**" kernel-doc notation
> marker but the function comments are not in kernel-doc format.

Well, I'd prefer if we added those required parameters rather than not and
"degrading" that function documentation back.

---
From: Borislav Petkov <bp@suse.de>
Date: Mon, 5 Nov 2018 10:26:02 +0100
Subject: [PATCH] resource: Complete kernel-doc style function documentation

Add the missing kernel-doc style function parameters documentation.

Based on a patch by Randy Dunlap <rdunlap@infradead.org>.

Fixes: b69c2e20f6e4 ("resource: Clean it up a bit")
Signed-off-by: Borislav Petkov <bp@suse.de>
Cc: Randy Dunlap <rdunlap@infradead.org>
---
 kernel/resource.c | 19 ++++++++++++++-----
 1 file changed, 14 insertions(+), 5 deletions(-)

diff --git a/kernel/resource.c b/kernel/resource.c
index b3a3a1fc499e..b0fbf685c77a 100644
--- a/kernel/resource.c
+++ b/kernel/resource.c
@@ -319,16 +319,23 @@ int release_resource(struct resource *old)
 EXPORT_SYMBOL(release_resource);
 
 /**
- * Finds the lowest iomem resource that covers part of [start..end].  The
- * caller must specify start, end, flags, and desc (which may be
+ * Finds the lowest iomem resource that covers part of [@start..@end].  The
+ * caller must specify @start, @end, @flags, and @desc (which may be
  * IORES_DESC_NONE).
  *
- * If a resource is found, returns 0 and *res is overwritten with the part
- * of the resource that's within [start..end]; if none is found, returns
- * -1.
+ * If a resource is found, returns 0 and @*res is overwritten with the part
+ * of the resource that's within [@start..@end]; if none is found, returns
+ * -1 or -EINVAL for other invalid parameters.
  *
  * This function walks the whole tree and not just first level children
  * unless @first_lvl is true.
+ *
+ * @start:	start address of the resource searched for
+ * @end:	end address of same resource
+ * @flags:	flags which the resource must have
+ * @desc:	descriptor the resource must have
+ * @first_lvl:	walk only the first level children, if set
+ * @res:	return ptr, if resource found
  */
 static int find_next_iomem_res(resource_size_t start, resource_size_t end,
 			       unsigned long flags, unsigned long desc,
@@ -399,6 +406,8 @@ static int __walk_iomem_res_desc(resource_size_t start, resource_size_t end,
  * @flags: I/O resource flags
  * @start: start addr
  * @end: end addr
+ * @arg: function argument for the callback @func
+ * @func: callback function that is called for each qualifying resource area
  *
  * NOTE: For a new descriptor search, define a new IORES_DESC in
  * <linux/ioport.h> and set it in 'desc' of a target resource entry.
-- 
2.19.1

-- 
Regards/Gruss,
    Boris.

SUSE Linux GmbH, GF: Felix Imendörffer, Jane Smithard, Graham Norton, HRB 21284 (AG Nürnberg)

  reply index

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-11-05  2:40 [PATCH] kernel/resource.c: fix " Randy Dunlap
2018-11-05  6:09 ` [tip:core/urgent] resource/docs: Fix " tip-bot for Randy Dunlap
2018-11-05  9:33   ` Borislav Petkov [this message]
2018-11-07 15:51     ` [tip:core/urgent] resource/docs: Complete kernel-doc style function documentation tip-bot for Borislav Petkov

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=20181105093307.GA12445@zn.tnic \
    --to=bp@suse.de \
    --cc=akpm@linux-foundation.org \
    --cc=hpa@zytor.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-tip-commits@vger.kernel.org \
    --cc=mingo@kernel.org \
    --cc=peterz@infradead.org \
    --cc=rdunlap@infradead.org \
    --cc=tglx@linutronix.de \
    --cc=torvalds@linux-foundation.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

LKML Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/lkml/0 lkml/git/0.git
	git clone --mirror https://lore.kernel.org/lkml/1 lkml/git/1.git
	git clone --mirror https://lore.kernel.org/lkml/2 lkml/git/2.git
	git clone --mirror https://lore.kernel.org/lkml/3 lkml/git/3.git
	git clone --mirror https://lore.kernel.org/lkml/4 lkml/git/4.git
	git clone --mirror https://lore.kernel.org/lkml/5 lkml/git/5.git
	git clone --mirror https://lore.kernel.org/lkml/6 lkml/git/6.git
	git clone --mirror https://lore.kernel.org/lkml/7 lkml/git/7.git
	git clone --mirror https://lore.kernel.org/lkml/8 lkml/git/8.git
	git clone --mirror https://lore.kernel.org/lkml/9 lkml/git/9.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 lkml lkml/ https://lore.kernel.org/lkml \
		linux-kernel@vger.kernel.org
	public-inbox-index lkml

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-kernel


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git