Commit 8f2709b5 authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds
Browse files

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



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: default avatarRandy Dunlap <rdunlap@xenotime.net>
Signed-off-by: default avatarAndrew Morton <akpm@osdl.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@osdl.org>
parent 6c8bec6d

Documentation/DocBook/kernel-api.tmpl

+3 −4
Original line number Diff line number Diff line
@@ -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>
@@ -501,7 +500,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>

include/linux/fs.h

+2 −0
Original line number Diff line number Diff line
@@ -1096,6 +1096,8 @@ int sync_inode(struct inode *inode, struct writeback_control *wbc); 
 * @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

include/linux/net.h

+1 −0
Original line number Diff line number Diff line
@@ -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.

 *

CRA Git | Maintained and supported by SUSTech CRA and CCSE