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

Unified · Split

kernel/resource.c+7−3
@@ -318,14 +318,14 @@ int release_resource(struct resource *old) · 317 unmodified lines
318318
319319 EXPORT_SYMBOL(release_resource);
320320
321−/**
321+/*
322322 * Finds the lowest iomem resource that covers part of [start..end]. The
323323 * caller must specify start, end, flags, and desc (which may be
324324 * IORES_DESC_NONE).
325325 *
326326 * If a resource is found, returns 0 and *res is overwritten with the part
327327 * of the resource that's within [start..end]; if none is found, returns
328− * -1.
328+ * -1. Returns -EINVAL for other invalid parameters.
329329 *
330330 * This function walks the whole tree and not just first level children
331331 * 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
390390 }
391391
392392 /**
393− * Walks through iomem resources and calls func() with matching resource
393+ * walk_iomem_res_desc - walk through iomem resources
394+ *
395+ * Walks through iomem resources and calls @func() with matching resource
394396 * ranges. This walks through whole tree and not just first level children.
395397 * All the memory ranges which overlap start,end and also match flags and
396398 * 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
399401 * @flags: I/O resource flags
400402 * @start: start addr
401403 * @end: end addr
404+ * @arg: function argument for the callback @func
405+ * @func: callback function that is called for each qualifying resource area
402406 *
403407 * NOTE: For a new descriptor search, define a new IORES_DESC in
404408 * <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