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

* [PATCH]man-pages : section 9  for kernel api description.
@ 2009-05-13  2:04 GeunSik Lim
  2009-05-13 11:33 ` Américo Wang
  0 siblings, 1 reply; 4+ messages in thread
From: GeunSik Lim @ 2009-05-13  2:04 UTC (permalink / raw)
  To: mtk.manpages; +Cc: tovalds, linux-kernel

[-- Attachment #1: Type: text/plain, Size: 4142 bytes --]



Dear Michael Kerrisk,

Are you maintainer of man-pages(man-pages-3.XX.tar.gz)?
I am not sure...

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
    
    The man software will display "Section 9"
    like the "KOBJECT_RENAME(9)" info about linux kernel API.
    
       KOBJECT_RENAME(9)                Driver Basics               KOBJECT_RENAME(9)
    
    If most developers all over the world understand "9" meaning
    as linux kernel API, Append "Section 9" info
    in the "man-pages-3.21.Announce" file of man-pages-3.XX.tar.gz .
    ( http://www.kernel.org/pub/linux/docs/manpages/man-pages-3.XX.tar.gz )
    
    	Signed-off-by: GeunSik Lim <geunsik.lim@samsung.com>

diff --git a/man-pages-3.22.Announce b/man-pages-3.22.Announce
index b52a38f..61f0f64 100644
--- a/man-pages-3.22.Announce
+++ b/man-pages-3.22.Announce
@@ -35,6 +35,7 @@ Here is a breakdown of what this distribution contains:
     Section 6 = games (intro only)
     Section 7 = overviews, conventions, macro packages, etc.
     Section 8 = system administration (intro, plus a few other pages)
+    Section 9 = linux kernel API (e.g., kthread_create, kthread_stop)
 
     This package contains no, or very few, section 1, 6, and 8 man pages
     because these should be distributed with the binaries they are written
diff --git a/man9/intro.9 b/man9/intro.9
new file mode 100644
index 0000000..5440579
--- /dev/null
+++ b/man9/intro.9
@@ -0,0 +1,36 @@
+.\" Copyright (c) 1993 Michael Haardt (michael@moria.de),
+.\"     Fri Apr  2 11:32:09 MET DST 1993
+.\"
+.\" This is free documentation; you can redistribute it and/or
+.\" modify it under the terms of the GNU General Public License as
+.\" published by the Free Software Foundation; either version 2 of
+.\" the License, or (at your option) any later version.
+.\"
+.\" The GNU General Public License's references to "object code"
+.\" and "executables" are to be interpreted as the output of any
+.\" document formatting or typesetting system, including
+.\" intermediate and printed output.
+.\"
+.\" This manual is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public
+.\" License along with this manual; if not, write to the Free
+.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
+.\" USA.
+.\"
+.\" Modified Sat Jul 24 17:19:57 1993 by Rik Faith (faith@cs.unc.edu)
+.\" Modified Wed May 24 10:39:14 2009 by GeunSik Lim (geunsik.lim@samsung.com)
+.TH INTRO 9 2007-10-23 "Linux" "Linux Programmer's Manual"
+.SH NAME
+intro \- Introduction to Linux kernel API
+.SH DESCRIPTION
+Section 9 of the manual describes all the Linux kernel API like kthread_create
+available on the system.
+.SH NOTES
+.SS Authors and Copyright Conditions
+Look at the header of the manual page source for the author(s) and copyright
+conditions.
+Note that these can be different from page to page!


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

GeunSik Lim (ELS - OS Group - S/W Lab - SAIT - SAMSUNG)
e-Mail  :1) geunsik.lim@samsung.com
         2) leemgs@gmail.com , leemgs1@gmail.com
HomePage: http://intomail.dnip.net/invain/me/
-----------------------------------------------

[-- Attachment #2: man-section9-kernel-api.patch --]
[-- Type: text/x-patch, Size: 3326 bytes --]

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
    
    The man software will display "Section 9"
    like the "KOBJECT_RENAME(9)" info about linux kernel API.
    
        KOBJECT_RENAME(9)                Driver Basics               KOBJECT_RENAME(9)
    
    If most developers all over the world understand "9" meaning
    as linux kernel API, Append "Section 9" info
    in the "man-pages-3.21.Announce" file of man-pages-3.XX.tar.gz .
    ( http://www.kernel.org/pub/linux/docs/manpages/man-pages-3.XX.tar.gz )
    
    	Signed-off-by: GeunSik Lim <geunsik.lim@samsung.com>

diff --git a/man-pages-3.22.Announce b/man-pages-3.22.Announce
index b52a38f..61f0f64 100644
--- a/man-pages-3.22.Announce
+++ b/man-pages-3.22.Announce
@@ -35,6 +35,7 @@ Here is a breakdown of what this distribution contains:
     Section 6 = games (intro only)
     Section 7 = overviews, conventions, macro packages, etc.
     Section 8 = system administration (intro, plus a few other pages)
+    Section 9 = linux kernel API (e.g., kthread_create, kthread_stop)
 
     This package contains no, or very few, section 1, 6, and 8 man pages
     because these should be distributed with the binaries they are written
diff --git a/man9/intro.9 b/man9/intro.9
new file mode 100644
index 0000000..5440579
--- /dev/null
+++ b/man9/intro.9
@@ -0,0 +1,36 @@
+.\" Copyright (c) 1993 Michael Haardt (michael@moria.de),
+.\"     Fri Apr  2 11:32:09 MET DST 1993
+.\"
+.\" This is free documentation; you can redistribute it and/or
+.\" modify it under the terms of the GNU General Public License as
+.\" published by the Free Software Foundation; either version 2 of
+.\" the License, or (at your option) any later version.
+.\"
+.\" The GNU General Public License's references to "object code"
+.\" and "executables" are to be interpreted as the output of any
+.\" document formatting or typesetting system, including
+.\" intermediate and printed output.
+.\"
+.\" This manual is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public
+.\" License along with this manual; if not, write to the Free
+.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
+.\" USA.
+.\"
+.\" Modified Sat Jul 24 17:19:57 1993 by Rik Faith (faith@cs.unc.edu)
+.\" Modified Wed May 24 10:39:14 2009 by GeunSik Lim (geunsik.lim@samsung.com)
+.TH INTRO 9 2007-10-23 "Linux" "Linux Programmer's Manual"
+.SH NAME
+intro \- Introduction to Linux kernel API
+.SH DESCRIPTION
+Section 9 of the manual describes all the Linux kernel API like kthread_create
+available on the system.
+.SH NOTES
+.SS Authors and Copyright Conditions
+Look at the header of the manual page source for the author(s) and copyright
+conditions.
+Note that these can be different from page to page!

^ permalink raw reply related	[flat|nested] 4+ messages in thread