Fixing make mandocs

DISCUSSION Andi Kleen 3 participants 6 messages Jan 23, 2006 Kernel janitors

Share & tools

Andi Kleen

author

2006-01-23 04:31 UTC #0 lore raw

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

_______________________________________________
Kernel-janitors mailing list
[email protected]
https://lists.osdl.org/mailman/listinfo/kernel-janitors

Randy.Dunlap

2006-01-23 04:49 UTC #1 lore raw

Quoted 10 lines · 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.

Quoted 9 lines

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

Quoted 3 lines

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

Quoted 2 lines

Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//fs/inode.c:1189): No descrip tion found for parameter 'dentry'

fixed

Quoted 2 lines

Warning(/usr/src/packages/BUILD/linux-2.6.16-rc1-3//fs/bio.c:427): No descriptio n found for parameter 'q'

fixed

Quoted 6 lines

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.

Quoted 10 lines

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.

Quoted 4 lines

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.

Quoted 2 lines

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.

Quoted 4 lines

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.

Quoted 1 line

make[1]: *** [Documentation/DocBook/kernel-api.xml] Error 1

---
~Randy

Andi Kleen

author

2006-01-23 04:52 UTC #2 lore raw

Quoted 11 lines · Randy.Dunlap

Quoted 9 lines · 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.

Quoted 5 lines

Quoted 1 line
-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
_______________________________________________
Kernel-janitors mailing list
[email protected]
https://lists.osdl.org/mailman/listinfo/kernel-janitors

Randy.Dunlap

2006-01-23 04:53 UTC #3 lore raw

Quoted 12 lines · On Mon, 23 Jan 2006 05:52:08 +0100 Andi Kleen wrote:

Quoted 11 lines · Randy.Dunlap
Quoted 9 lines · 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.

Quoted 7 lines

Quoted 5 lines
Quoted 1 line
-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

Martin Waitz

2006-01-23 12:28 UTC #4 lore raw

hoi :)

Quoted 4 lines · Randy.Dunlap

Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
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.

Quoted 1 line

Quoted 1 line
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.

Signature · 1 line

Martin Waitz

_______________________________________________
Kernel-janitors mailing list
[email protected]
https://lists.osdl.org/mailman/listinfo/kernel-janitors

Andi Kleen

author

2006-01-23 12:52 UTC #5 lore raw

Quoted 8 lines · Martin Waitz

hoi :)
Quoted 4 lines · Randy.Dunlap
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
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.

Quoted 7 lines

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.
Quoted 1 line
Quoted 1 line
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