Message-ID: <49C122DF.7020803@redhat.com>
Date: Wed, 18 Mar 2009 12:35:43 -0400
From: William Cohen <wcohen@redhat.com>
User-Agent: Thunderbird 2.0.0.19 (X11/20090105)
MIME-Version: 1.0
To: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Subject: Documenting kernel tracepoints
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Content-Length: 940
Lines: 22

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@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/