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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <49b7c2350905130806jc02a4dfg8b04ec2de4fb1ff4@mail.gmail.com>
Date:	Thu, 14 May 2009 00:06:30 +0900
From:	GeunSik Lim <leemgs1@...il.com>
To:	Américo Wang <xiyou.wangcong@...il.com>
Cc:	mtk.manpages@...il.com, tovalds@...ux-foundation.org,
	linux-kernel <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH]man-pages : section 9 for kernel api description.

Thank you for your opinion.

2009/5/13 Américo Wang <xiyou.wangcong@...il.com>:
> 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@...il.com>
>>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?
>
I want Michael to append patch file  in the man-pages source that I
sent because
Many linux distributions (ex: Fedora , openSUSE, and so on ) already
support  kernel api for man currently.
In general, kernel api(ex:kernel-doc-2.6.29.1-30.fc10.noarch.rpm) is
located in the
/usr/share/man/man9/ directory when we installed linux distribution
like Fedora by default.
So, I think that we need description and section 9 folder(man9) in the
man-pages source
to understand  meaning of man 9.


> Kernel APIs are not stable at all, this is also a reason why you
> should not include their doc into man pages.
I agree that Kernel APIs is not stable.
But, I believe that we can utilize "#> man <linux-kernel-api>" command
in the own
Linux distribution easy to use about "uname -a" Linux kernel version.
This support is a valuable. I think that The problem deserves solving.

Thanks reading.

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



-- 
Regards,
GeunSik Lim
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/