[PATCH] v4l: fix kernel-doc warning, function name, and docbookfilename

From: Randy Dunlap
Date: Mon Jul 28 2008 - 14:46:19 EST


From: Randy Dunlap <randy.dunlap@xxxxxxxxxx>

Change function name in kernel-doc and add kernel-doc for parameter @index:
Warning(linhead//drivers/media/video/videodev.c:2090): No description found for parameter 'index'

Also change source file name in DocBook/videobook.tmpl to match the new
source file name.

Signed-off-by: Randy Dunlap <randy.dunlap@xxxxxxxxxx>
---
Documentation/DocBook/videobook.tmpl | 2 +-
drivers/media/video/v4l2-dev.c | 4 +++-
2 files changed, 4 insertions(+), 2 deletions(-)

--- head.orig/drivers/media/video/v4l2-dev.c
+++ head/drivers/media/video/v4l2-dev.c
@@ -222,11 +222,13 @@ int video_register_device(struct video_d
EXPORT_SYMBOL(video_register_device);

/**
- * video_register_device - register video4linux devices
+ * video_register_device_index - register video4linux devices
* @vfd: video device structure we want to register
* @type: type of device to register
* @nr: which device number (0 == /dev/video0, 1 == /dev/video1, ...
* -1 == first free)
+ * @index: stream number based on parent device;
+ * -1 if auto assign, requested number otherwise
*
* The registration code assigns minor numbers based on the type
* requested. -ENFILE is returned in all the device slots for this
--- head.orig/Documentation/DocBook/videobook.tmpl
+++ head/Documentation/DocBook/videobook.tmpl
@@ -1648,7 +1648,7 @@ static struct video_buffer capture_fb;

<chapter id="pubfunctions">
<title>Public Functions Provided</title>
-!Edrivers/media/video/videodev.c
+!Edrivers/media/video/v4l2-dev.c
</chapter>

</book>
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/