Messages in this thread | | | Date | Sun, 22 Jan 2006 20:49:21 -0800 | From | "Randy.Dunlap" <> | Subject | Re: Fixing make mandocs |
| |
On Mon, 23 Jan 2006 05:31:27 +0100 Andi Kleen wrote:
> > Here would be a good janitor task for 2.6.16. make mandocs currently > doesn't build because a number of descriptions are missing parameters etc. > It would be good if someone could fix that and submit patches for 2.6.16. > > It should be relatively straight forward, if one cannot figure out > what a missing parameter does adding a dummy description ("Undocumented") > would be also ok. > > -Andi
Lots of these have been fixed in the last 2-3 days by Martin Waitz and/or me and have been posted on lkml. Martin is collecting them in his kernel-doc tree.
> DOCPROC Documentation/DocBook/kernel-api.xml > Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//mm/slab.c:1505): No descript > ion found for parameter 'cachep' > Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//mm/slab.c:1505): No descript > ion found for parameter 'size' > Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//mm/slab.c:1505): No descript > ion found for parameter 'align' > Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//mm/slab.c:1505): No descript > ion found for parameter 'flags'
mm/slab.c fixed
> Error(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//include/asm-i386/uaccess.h:416 > ): cannot understand prototype: '__always_inline unsigned long __must_check __co > py_to_user_inatomic(void __user *to, const void *from, unsigned long n) '
uaccess.h fixed
> Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//fs/inode.c:1189): No descrip > tion found for parameter 'dentry'
fixed
> Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//fs/bio.c:427): No descriptio > n found for parameter 'q'
fixed
> Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//include/linux/skbuff.h:308): > No description found for parameter 'copied_early' > Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//include/linux/skbuff.h:308): > No description found for parameter 'dma_cookie' > Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//net/core/skbuff.c:211): No d > escription found for parameter 'fclone'
above seem to be needed.
> Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//net/sunrpc/sched.c:920): No > description found for parameter 'clnt' > Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//net/sunrpc/sched.c:920): No > description found for parameter 'flags' > Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//net/sunrpc/sched.c:920): No > description found for parameter 'ops' > Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//net/sunrpc/sched.c:920): No > description found for parameter 'data' > Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//net/sunrpc/sched.c:942): No > description found for parameter 'parent'
These are fixed.
> Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//net/core/dev.c:3317): No des > cription found for parameter 'chan' > Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//net/core/dev.c:3317): No des > cription found for parameter 'event'
Above seem to be needed.
> Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//kernel/irq/manage.c:177): No > description found for parameter 'new'
Fix seems to be needed.
> Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//block/ll_rw_blk.c:317): No d > escription found for parameter 'prepare_flush_fn' > Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//block/ll_rw_blk.c:2637): No > description found for parameter 'error'
Martin fixed those.
> make[1]: *** [Documentation/DocBook/kernel-api.xml] Error 1
--- ~Randy - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
| |