All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Américo Wang" <xiyou.wangcong@gmail.com>
To: GeunSik Lim <leemgs1@gmail.com>
Cc: mtk.manpages@gmail.com, tovalds@linux-foundation.org,
	linux-kernel <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH]man-pages : section 9  for kernel api description.
Date: Wed, 13 May 2009 19:33:57 +0800	[thread overview]
Message-ID: <20090513113357.GA11773@hack> (raw)
In-Reply-To: <1242180268.31161.24.camel@centos51>

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@gmail.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?

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.
 

  reply	other threads:[~2009-05-13 11:32 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-05-13  2:04 [PATCH]man-pages : section 9 for kernel api description GeunSik Lim
2009-05-13 11:33 ` Américo Wang [this message]
2009-05-13 15:06   ` GeunSik Lim
2009-07-25  4:47     ` Michael Kerrisk

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20090513113357.GA11773@hack \
    --to=xiyou.wangcong@gmail.com \
    --cc=leemgs1@gmail.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mtk.manpages@gmail.com \
    --cc=tovalds@linux-foundation.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.