TAPSET REFERENCE GUIDE: DOCUMENTATION PLAN

PURPOSE

PROCESS

DOCUMENTING A TAPSET

/**
 * probe tapset.name - Short summary of what the tapset does.
 * @argument: Explanation of argument.
 * @argument2: Explanation of argument2. Probes can have multiple arguments.
 *
 * Context:
 * A brief explanation of the tapset context. Note that the context should only be 1 paragraph short.
 *
 * Text that will appear under "Description."
 *
 * A new paragraph that will also appear under the heading "Description".
 *
 * Header:
 * A paragraph that will appear under the heading "Header".
 **/

/**
 * probe vm.write_shared_copy- Page copy for shared page write.
 * @address: The address of the shared write.
 * @zero: Boolean indicating whether it is a zero page
 *         (can do a clear instead of a copy).
 *
 * Context:
 *  The process attempting the write.
 *
 *  Fires when a write to a shared page requires a page copy.  This is
 *  always preceded by a <command>vm.shared_write</command>.
 */

 * Synopsis:
 * <programlisting>Synopsis string</programlisting>
 *

/**
 * probe signal.handle - Fires when the signal handler is invoked
 * @sig: The signal number that invoked the signal handler
 *
 * Synopsis:
 * <programlisting>static int handle_signal(unsigned long sig, siginfo_t *info, struct k_sigaction *ka,
 * sigset_t *oldset, struct pt_regs * regs)</programlisting>
 */

COVERAGE

Reference:[[javascript:void(0);/*1236215903752*/|http://sources.redhat.com/git/gitweb.cgi?p=systemtap.git;a=tree;f=tapset;h=35b83b7e88406af2521d34604db12ed081a245eb;hb=HEAD]]

Schedule

For any questions about this project, please feel free to contact ddomingo at redhat dot com.

None: ProjectTapsetReferenceGuide (last edited 2009-03-05 01:19:24 by Don Domingo)