Commit f75d6515 authored Nov 04, 2018 by Randy Dunlap Committed by Ingo Molnar Nov 05, 2018

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.
Also add another error return value here.

  ../kernel/resource.c:337: warning: Function parameter or member 'start' not described in 'find_next_iomem_res'
  ../kernel/resource.c:337: warning: Function parameter or member 'end' not described in 'find_next_iomem_res'
  ../kernel/resource.c:337: warning: Function parameter or member 'flags' not described in 'find_next_iomem_res'
  ../kernel/resource.c:337: warning: Function parameter or member 'desc' not described in 'find_next_iomem_res'
  ../kernel/resource.c:337: warning: Function parameter or member 'first_lvl' not described in 'find_next_iomem_res'
  ../kernel/resource.c:337: warning: Function parameter or member 'res' not described in 'find_next_iomem_res'

Add the missing function parameter documentation for the other warnings:

  ../kernel/resource.c:409: warning: Function parameter or member 'arg' not described in 'walk_iomem_res_desc'
  ../kernel/resource.c:409: warning: Function parameter or member 'func' not described in 'walk_iomem_res_desc'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Borislav Petkov <bp@suse.de>
Cc: Linus Torvalds <torvalds@linux-foundation.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Fixes: b69c2e20 ("resource: Clean it up a bit")
Link: http://lkml.kernel.org/r/dda2e4d8-bedd-3167-20fe-8c7d2d35b354@infradead.org


Signed-off-by: Ingo Molnar <mingo@kernel.org>

parent 5b744981

kernel/resource.c

+7 −3

Original line number	Diff line number	Diff line
		@@ -318,14 +318,14 @@ 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
		* 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.
		* -1. Returns -EINVAL for other invalid parameters.
		*
		* This function walks the whole tree and not just first level children
		* unless @first_lvl is true.
		@@ -390,7 +390,9 @@ static int __walk_iomem_res_desc(resource_size_t start, resource_size_t end,
		}

		/**
		* Walks through iomem resources and calls func() with matching resource
		* walk_iomem_res_desc - walk through iomem resources
		*
		* Walks through iomem resources and calls @func() with matching resource
		* ranges. This walks through whole tree and not just first level children.
		* All the memory ranges which overlap start,end and also match flags and
		* desc are valid candidates.
		@@ -399,6 +401,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.