Documenting kernel tracepoints

From: William Cohen
Date: Wed Mar 18 2009 - 12:36:16 EST


There are a number of tracepoints in the latest kernels, but not much
documentation on the tracepoints. If a very recent version of
systemtap is available on the system, a list of the probe points can
be obtained with:

stap -p2 -e 'probe kernel.trace("*") {exit()}'|sort

However, this only provides the names. It doesn't provide information
about what information the probe point provides or the arguments
available at the probe point.

Currently, a number of kernel functions and structures are documented
with embedded comments that are extracted with kernel-doc. Seems like
it would be reasonable to extend this to support tracepoints.
Any thoughts or comments about this approach?

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