linux-kernel - Re: [tip:core/urgent] resource/docs: Fix new kernel-doc warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20181105093307.GA12445@zn.tnic>
Date:   Mon, 5 Nov 2018 10:33:07 +0100
From:   Borislav Petkov <bp@...e.de>
To:     rdunlap@...radead.org
Cc:     linux-tip-commits@...r.kernel.org, akpm@...ux-foundation.org,
        peterz@...radead.org, rdunlap@...radead.org,
        torvalds@...ux-foundation.org, tglx@...utronix.de,
        mingo@...nel.org, hpa@...or.com, linux-kernel@...r.kernel.org
Subject: Re: [tip:core/urgent] resource/docs: Fix new kernel-doc warnings

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@...radead.org>
> AuthorDate: Sun, 4 Nov 2018 18:40:14 -0800
> Committer:  Ingo Molnar <mingo@...nel.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@...e.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@...radead.org>.

Fixes: b69c2e20f6e4 ("resource: Clean it up a bit")
Signed-off-by: Borislav Petkov <bp@...e.de>
Cc: Randy Dunlap <rdunlap@...radead.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)