Re: Documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 23/10/06, Alan Menegotto <macnish@xxxxxxxxx> wrote:
Hi.

Anyone know a tool to easily document the codepath for a single
operation in kernel mode (i.e. TCP 3-way handshake)?

Probably not exactely what you are looking for, but if you run "make
tags" in your kernel source dir, then you'll have an index that lets
you follow "tags" easily in many editors. What this means is that if
you place the cursor on a function name you can jump to the definition
with a keypress and back again with another (even when the definition
is in a different file).
For example, in 'vi' you can use these :

:ta tag
   Find a tag.
Ctrl-]
   Find the tag under the cursor.
Ctrl-T
   Return to previous location before jump to tag

Many other editors can be used as well in similar ways.

This makes it a bit easier to navigate the source.

You can also use "make cscope" to generate a cscope index
(http://cscope.sourceforge.net/)

In addition, you also have the kerneldoc documentation which you can
get at by running "make mandocs", "make xmldocs", "make pdfdocs"
etc... see "make help" for more.


Hope that helps you a bit.

--
Jesper Juhl <jesper.juhl@xxxxxxxxx>
Don't top-post  http://www.catb.org/~esr/jargon/html/T/top-post.html
Plain text mails only, please      http://www.expita.com/nomime.html

--
Kernelnewbies: Help each other learn about the Linux kernel.
Archive:       http://mail.nl.linux.org/kernelnewbies/
FAQ:           http://kernelnewbies.org/faq/


[Index of Archives]     [Newbies FAQ]     [Linux Kernel Mentors]     [Linux Kernel Development]     [IETF Annouce]     [Git]     [Networking]     [Security]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux SCSI]     [Linux ACPI]
  Powered by Linux