History

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'

Randy Dunlap committed 8 years ago

Commit f75d6511 parent 5b744981 file · +7 −3Browse files

Showing the changes to kernel (1 of 1 file). Show all

Unified · Split

kernel/resource.c+7−3
@@ -318,14 +318,14 @@ int release_resource(struct resource *old) · 317 unmodified lines
318 318
319EXPORT_SYMBOL(release_resource);319EXPORT_SYMBOL(release_resource);
320 320
321/**321/*
322 * Finds the lowest iomem resource that covers part of [start..end]. The322 * Finds the lowest iomem resource that covers part of [start..end]. The
323 * caller must specify start, end, flags, and desc (which may be323 * caller must specify start, end, flags, and desc (which may be
324 * IORES_DESC_NONE).324 * IORES_DESC_NONE).
325 *325 *
326 * If a resource is found, returns 0 and *res is overwritten with the part326 * If a resource is found, returns 0 and *res is overwritten with the part
327 * of the resource that's within [start..end]; if none is found, returns327 * of the resource that's within [start..end]; if none is found, returns
328 * -1.328 * -1. Returns -EINVAL for other invalid parameters.
329 *329 *
330 * This function walks the whole tree and not just first level children330 * This function walks the whole tree and not just first level children
331 * unless @first_lvl is true.331 * unless @first_lvl is true.
@@ -390,7 +390,9 @@ static int __walk_iomem_res_desc(resource_size_t start, resource_size_t end, · 58 unmodified lines
390}390}
391 391
392/**392/**
393 * Walks through iomem resources and calls func() with matching resource393 * walk_iomem_res_desc - walk through iomem resources
394 *
395 * Walks through iomem resources and calls @func() with matching resource
394 * ranges. This walks through whole tree and not just first level children.396 * ranges. This walks through whole tree and not just first level children.
395 * All the memory ranges which overlap start,end and also match flags and397 * All the memory ranges which overlap start,end and also match flags and
396 * desc are valid candidates.398 * desc are valid candidates.
@@ -399,6 +401,8 @@ static int __walk_iomem_res_desc(resource_size_t start, resource_size_t end, · 2 unmodified lines
399 * @flags: I/O resource flags401 * @flags: I/O resource flags
400 * @start: start addr402 * @start: start addr
401 * @end: end addr403 * @end: end addr
404 * @arg: function argument for the callback @func
405 * @func: callback function that is called for each qualifying resource area
402 *406 *
403 * NOTE: For a new descriptor search, define a new IORES_DESC in407 * NOTE: For a new descriptor search, define a new IORES_DESC in
404 * <linux/ioport.h> and set it in 'desc' of a target resource entry.408 * <linux/ioport.h> and set it in 'desc' of a target resource entry.

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t