Re: [PATCH]man-pages : section 9 for kernel api description.

From: AmÃrico Wang
Date: Wed May 13 2009 - 07:32:54 EST


On Wed, May 13, 2009 at 11:04:28AM +0900, GeunSik Lim wrote:
>
>
>Dear Michael Kerrisk,
>
>Are you maintainer of man-pages(man-pages-3.XX.tar.gz)?
>I am not sure...

Yes, he is.

>
>I use fedora 9 distribution as Linux based Desktop OS currently.
>I have one proposal about "#> man <linux-kernel-api>" command.
>Can you tell me your opinion about below patch?
>Thanks reading.
>
>commit 45e950c98412c002c47254507a199731315c7c2b
>Author: GeunSik,Lim <leemgs1@xxxxxxxxx>
>Date: Wed May 13 10:49:47 2009 +0900
>
> Append Section 9 info of man command.
>
> We view description of the Linux kernel API with man command.
> For example,
> Fedoar9#> yum install kernel-doc*
> Fedora9#> man kobject_rename or
> Fedora9#> man kthread_create

Why?
Why do you want kernel api doc be in man pages?
Why not just browsing the kernel source code?

Kernel APIs are not stable at all, this is also a reason why you
should not include their doc into man pages.

--
Live like a child, think like the god.

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