Re: Man pages for Kernel API

2014-06-05 Thread navid Rahimi
ok . i figure it out .
you should have have have kernel source tree ( which i think most of us had).
any way if you dont :

$git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
$cd linux
$make mandocs
#make installmandocs
#mandb

(and yes you should have xmlto and other package installed )

i hope this will help.


best wishes,
-navid


On Thu, Jun 5, 2014 at 4:44 AM, navid Rahimi  wrote:
> thank you frank , for make this clear .
> so frank in this case can you be more specific , what should i do ?
> for example i installed kernel-doc , even downloaded kernel man page
> from kernel.org and completed make install routine . but , for example
> i don't have any kmalloc man page yet in my fedora . last time i was
> in arch linux , i had it .
>
> best wishes,
> -navid
>
>
> On Thu, Jun 5, 2014 at 2:49 AM, Frank Ch. Eigler  wrote:
>>
>> navid Rahimi  writes:
>>
>>> probe::vm.kmalloc (3stap) - Fires when kmalloc is requested
>>> probe::vm.kmalloc_node (3stap) - Fires when kmalloc_node is requested
>>
>> Those are systemtap man pages, not kernel API ones.
>>
>> - FChE

___
Kernelnewbies mailing list
Kernelnewbies@kernelnewbies.org
http://lists.kernelnewbies.org/mailman/listinfo/kernelnewbies


Re: Man pages for Kernel API

2014-06-04 Thread navid Rahimi
thank you frank , for make this clear .
so frank in this case can you be more specific , what should i do ?
for example i installed kernel-doc , even downloaded kernel man page
from kernel.org and completed make install routine . but , for example
i don't have any kmalloc man page yet in my fedora . last time i was
in arch linux , i had it .

best wishes,
-navid


On Thu, Jun 5, 2014 at 2:49 AM, Frank Ch. Eigler  wrote:
>
> navid Rahimi  writes:
>
>> probe::vm.kmalloc (3stap) - Fires when kmalloc is requested
>> probe::vm.kmalloc_node (3stap) - Fires when kmalloc_node is requested
>
> Those are systemtap man pages, not kernel API ones.
>
> - FChE

___
Kernelnewbies mailing list
Kernelnewbies@kernelnewbies.org
http://lists.kernelnewbies.org/mailman/listinfo/kernelnewbies


Re: Man pages for Kernel API

2014-06-04 Thread Frank Ch. Eigler

navid Rahimi  writes:

> probe::vm.kmalloc (3stap) - Fires when kmalloc is requested
> probe::vm.kmalloc_node (3stap) - Fires when kmalloc_node is requested

Those are systemtap man pages, not kernel API ones.

- FChE

___
Kernelnewbies mailing list
Kernelnewbies@kernelnewbies.org
http://lists.kernelnewbies.org/mailman/listinfo/kernelnewbies


Re: Man pages for Kernel API

2014-06-04 Thread navid Rahimi
i dont know which distro you ( Dipanjan Das ) using , but in fedora i
should use something like this for kmalloc :

┌─[✗]─[13:18:11]─[navid@HOME]
└──> ~ $ >> man -k kmalloc
probe::vm.kmalloc (3stap) - Fires when kmalloc is requested
probe::vm.kmalloc_node (3stap) - Fires when kmalloc_node is requested
┌─[13:18:12]─[navid@HOME]
└──> ~ $ >> man probe::vm.kmalloc

seems man files divided to probe and subsystem vm and functions.
if you cannot find yet,  you should ask your distro IRC/mailing list
to what to do next.

best wishes,
-navid


On Tue, Jun 3, 2014 at 10:49 PM, John de la Garza  wrote:
> On Tue, Jun 03, 2014 at 10:12:24AM +0530, Dipanjan Das wrote:
>> Hi,
>>
>> Like there is section #2 of man pages dedicated to syscalls, is there any
>> official way to get the list of all supported Kernal APIs?
>
> check out the man page for man itself (man man)
>
> look for this:
>
> 9   Kernel routines [Non standard]
>
>
>
> You may need to install them (man 9 files) as they may not be installed
>
> ## example
>
> john@vega:~/download/koans$ man -k printk
> printk (9)   - print a kernel message
> printk_timed_ratelimit (9) - caller-controlled printk ratelimiting
> snd_printd (9)   - debug printk
> snd_printdd (9)  - debug printk
> snd_printk (9)   - printk wrapper
> trace_printk (9) - printf formatting in the ftrace buffer
>
>
> ___
> Kernelnewbies mailing list
> Kernelnewbies@kernelnewbies.org
> http://lists.kernelnewbies.org/mailman/listinfo/kernelnewbies

___
Kernelnewbies mailing list
Kernelnewbies@kernelnewbies.org
http://lists.kernelnewbies.org/mailman/listinfo/kernelnewbies


Re: Man pages for Kernel API

2014-06-03 Thread John de la Garza
On Tue, Jun 03, 2014 at 10:12:24AM +0530, Dipanjan Das wrote:
> Hi,
> 
> Like there is section #2 of man pages dedicated to syscalls, is there any
> official way to get the list of all supported Kernal APIs?

check out the man page for man itself (man man)

look for this:

9   Kernel routines [Non standard]



You may need to install them (man 9 files) as they may not be installed

## example

john@vega:~/download/koans$ man -k printk
printk (9)   - print a kernel message
printk_timed_ratelimit (9) - caller-controlled printk ratelimiting
snd_printd (9)   - debug printk
snd_printdd (9)  - debug printk
snd_printk (9)   - printk wrapper
trace_printk (9) - printf formatting in the ftrace buffer


___
Kernelnewbies mailing list
Kernelnewbies@kernelnewbies.org
http://lists.kernelnewbies.org/mailman/listinfo/kernelnewbies


Man pages for Kernel API

2014-06-02 Thread Dipanjan Das
Hi,

Like there is section #2 of man pages dedicated to syscalls, is there any
official way to get the list of all supported Kernal APIs?
___
Kernelnewbies mailing list
Kernelnewbies@kernelnewbies.org
http://lists.kernelnewbies.org/mailman/listinfo/kernelnewbies