[PATCH] kernel-doc: fix some kernel-api warnings

[Randy.Dunlap]

From: Randy Dunlap <rdunlap@xxxxxxxxxxxx>

Fix various warnings in kernel-doc:

Warning(linux-2614-rc4//include/linux/net.h:89): Enum value 'SOCK_DCCP' not described in enum 'sock_type'

usercopy.c: should use !E instead of !I for exported symbols:
Warning(linux-2614-rc4//arch/i386/lib/usercopy.c): no structured comments found

fs.h does not need to use !E since it has no exported symbols:
Warning(linux-2614-rc4//include/linux/fs.h:1182): No description found for parameter 'find_exported_dentry'
Warning(linux-2614-rc4//include/linux/fs.h): no structured comments found

irq/manage.c should use !E for its exported symbols:
Warning(linux-2614-rc4//kernel/irq/manage.c): no structured comments found

macmodes.c should use !E for its exported symbols:
Warning(linux-2614-rc4//drivers/video/macmodes.c): no structured comments found

Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxx>
---

 Documentation/DocBook/kernel-api.tmpl |    7 +++----
 include/linux/fs.h                    |    2 ++
 include/linux/net.h                   |    1 +
 3 files changed, 6 insertions(+), 4 deletions(-)

diff -Naurp linux-2614-rc4/Documentation/DocBook/kernel-api.tmpl~doc_kernel_api linux-2614-rc4/Documentation/DocBook/kernel-api.tmpl
--- linux-2614-rc4/Documentation/DocBook/kernel-api.tmpl~doc_kernel_api	2005-08-28 16:41:01.000000000 -0700
+++ linux-2614-rc4/Documentation/DocBook/kernel-api.tmpl	2005-10-15 23:06:11.000000000 -0700
@@ -118,7 +118,7 @@ X!Ilib/string.c
      </sect1>
      <sect1><title>User Space Memory Access</title>
 !Iinclude/asm-i386/uaccess.h
-!Iarch/i386/lib/usercopy.c
+!Earch/i386/lib/usercopy.c
      </sect1>
      <sect1><title>More Memory Management Functions</title>
 !Iinclude/linux/rmap.h
@@ -174,7 +174,6 @@ X!Ilib/string.c
      <title>The Linux VFS</title>
      <sect1><title>The Filesystem types</title>
 !Iinclude/linux/fs.h
-!Einclude/linux/fs.h
      </sect1>
      <sect1><title>The Directory Cache</title>
 !Efs/dcache.c
@@ -266,7 +265,7 @@ X!Ekernel/module.c
   <chapter id="hardware">
      <title>Hardware Interfaces</title>
      <sect1><title>Interrupt Handling</title>
-!Ikernel/irq/manage.c
+!Ekernel/irq/manage.c
      </sect1>
 
      <sect1><title>Resources Management</title>
@@ -499,7 +498,7 @@ KAO -->
 !Edrivers/video/modedb.c
      </sect1>
      <sect1><title>Frame Buffer Macintosh Video Mode Database</title>
-!Idrivers/video/macmodes.c
+!Edrivers/video/macmodes.c
      </sect1>
      <sect1><title>Frame Buffer Fonts</title>
         <para>
diff -Naurp linux-2614-rc4/include/linux/fs.h~doc_kernel_api linux-2614-rc4/include/linux/fs.h
--- linux-2614-rc4/include/linux/fs.h~doc_kernel_api	2005-10-14 17:31:29.000000000 -0700
+++ linux-2614-rc4/include/linux/fs.h	2005-10-15 22:44:15.000000000 -0700
@@ -1082,6 +1082,8 @@ int sync_inode(struct inode *inode, stru
  * @get_name:       find the name for a given inode in a given directory
  * @get_parent:     find the parent of a given directory
  * @get_dentry:     find a dentry for the inode given a file handle sub-fragment
+ * @find_exported_dentry:
+ *	set by the exporting module to a standard helper function.
  *
  * Description:
  *    The export_operations structure provides a means for nfsd to communicate
diff -Naurp linux-2614-rc4/include/linux/net.h~doc_kernel_api linux-2614-rc4/include/linux/net.h
--- linux-2614-rc4/include/linux/net.h~doc_kernel_api	2005-10-14 17:31:29.000000000 -0700
+++ linux-2614-rc4/include/linux/net.h	2005-10-15 23:16:08.000000000 -0700
@@ -71,6 +71,7 @@ typedef enum {
  * @SOCK_RAW: raw socket
  * @SOCK_RDM: reliably-delivered message
  * @SOCK_SEQPACKET: sequential packet socket
+ * @SOCK_DCCP: Datagram Congestion Control Protocol socket
  * @SOCK_PACKET: linux specific way of getting packets at the dev level.
  *		  For writing rarp and other similar things on the user level.
  *


---
-
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/