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
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'
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) '
Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//fs/inode.c:1189): No descrip
tion found for parameter 'dentry'
Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//fs/bio.c:427): No descriptio
n found for parameter 'q'
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'
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'
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'
Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//kernel/irq/manage.c:177): No
description found for parameter 'new'
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'
make[1]: *** [Documentation/DocBook/kernel-api.xml] Error 1
On Mon, 23 Jan 2006 05:52:08 +0100 Andi Kleen wrote:
> On Monday 23 January 2006 05:49, Randy.Dunlap wrote:
> > 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.
>
> Ok good. Are they going into 2.6.16?
I have no idea. Depends on whether Martin (cc-ed) or Andrew
pushes them, I guess.
---
~Randy
On Monday 23 January 2006 05:49, Randy.Dunlap wrote:
> 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.
Ok good. Are they going into 2.6.16?
-Andi
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
hoi :)
On Sun, Jan 22, 2006 at 08:53:49PM -0800, Randy.Dunlap 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.
the thing that really breaks the build is the new __copy_to_user
prototype which kernel-doc could not understand.
This is fixed in my tree.
> > Ok good. Are they going into 2.6.16?
I'll try to get at least the one kernel-doc fix into 2.6.16.
--
Martin Waitz
On Monday 23 January 2006 13:28, Martin Waitz wrote:
> hoi :)
>
> On Sun, Jan 22, 2006 at 08:53:49PM -0800, Randy.Dunlap 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.
>
> the thing that really breaks the build is the new __copy_to_user
> prototype which kernel-doc could not understand.
> This is fixed in my tree.
>
> > > Ok good. Are they going into 2.6.16?
>
> I'll try to get at least the one kernel-doc fix into 2.6.16.
I would just send all that fix build failures.
-Andi