summaryrefslogtreecommitdiffstats
path: root/tapset/signal.stp
diff options
context:
space:
mode:
authorFrank Ch. Eigler <fche@elastic.org>2009-09-29 14:09:32 -0400
committerFrank Ch. Eigler <fche@elastic.org>2009-09-29 14:09:32 -0400
commit7a18a12684f498929b5938ceb18f66b18d2e1fe3 (patch)
treee2ef22aac08b85a54094445f7ec0509dbd45e304 /tapset/signal.stp
parentf3d75239e30b5ba55936d9340b0e95caa698034b (diff)
downloadsystemtap-steved-7a18a12684f498929b5938ceb18f66b18d2e1fe3.tar.gz
systemtap-steved-7a18a12684f498929b5938ceb18f66b18d2e1fe3.tar.xz
systemtap-steved-7a18a12684f498929b5938ceb18f66b18d2e1fe3.zip
tapset docs cleanup
Several problems: some invalid <command> etc. directives in the tapset embedded docs; some analysis about the non-generation of the pdf; some cleanup of the generated man pages. * configure.ac (BUILD_PDFREFDOCS): Correct condition typo, but still leave disabled. * doc/SystemTap_Tapset_Reference/Makefile.am (XMLTOMANPARMS): Add, to disable noise "AUTHORS" / "COPYRIGHT" sections. * tapset/*.stp: Removed several docbook-y markup that is not valid in kerneldoc.
Diffstat (limited to 'tapset/signal.stp')
-rw-r--r--tapset/signal.stp100
1 files changed, 50 insertions, 50 deletions
diff --git a/tapset/signal.stp b/tapset/signal.stp
index 2e10af0c..fcc2363a 100644
--- a/tapset/signal.stp
+++ b/tapset/signal.stp
@@ -26,10 +26,10 @@
* @pid_name: The name of the signal recipient
* @si_code: Indicates the signal type
* @task: A task handle to the signal recipient
- * @sinfo: The address of <command>siginfo</command> struct
+ * @sinfo: The address of siginfo struct
* @shared: Indicates whether the signal is shared by the thread group
* @send2queue: Indicates whether the signal is sent to an existing
- * <command>sigqueue</command>
+ * sigqueue
* @name: The name of the function used to send out the signal
*
* Context:
@@ -119,41 +119,41 @@ probe _signal.send.part3 = kernel.function("send_sigqueue")
/**
* probe signal.send.return - Signal being sent to a process completed
- * @retstr: The return value to either <command>__group_send_sig_info</command>,
- * <command>specific_send_sig_info</command>,
- * or <command>send_sigqueue</command>
+ * @retstr: The return value to either __group_send_sig_info,
+ * specific_send_sig_info,
+ * or send_sigqueue
* @shared: Indicates whether the sent signal is shared by the thread group.
* @send2queue: Indicates whether the sent signal was sent to an
- * existing <command>sigqueue</command>
+ * existing sigqueue
* @name: The name of the function used to send out the signal
*
* Context:
- * The signal's sender. <remark>(correct?)</remark>
+ * The signal's sender. (correct?)
*
- * Possible <command>__group_send_sig_info</command> and
- * <command>specific_send_sig_info</command> return values are as follows;
+ * Possible __group_send_sig_info and
+ * specific_send_sig_info return values are as follows;
*
- * <command>0</command> -- The signal is sucessfully sent to a process,
- * which means that
- * <1> the signal was ignored by the receiving process,
- * <2> this is a non-RT signal and the system already has one queued, and
- * <3> the signal was successfully added to the <command>sigqueue</command> of the receiving process.
+ * 0 -- The signal is sucessfully sent to a process,
+ * which means that:
+ * (1) the signal was ignored by the receiving process,
+ * (2) this is a non-RT signal and the system already has one queued, and
+ * (3) the signal was successfully added to the sigqueue of the receiving process.
*
- * <command>-EAGAIN</command> -- The <command>sigqueue</command> of the receiving process is
+ * -EAGAIN -- The sigqueue of the receiving process is
* overflowing, the signal was RT, and the signal was sent by a user using something other
- * than <command>kill()</command>.
+ * than kill().
*
- * Possible <command>send_group_sigqueue</command> and
- * <command>send_sigqueue</command> return values are as follows;
+ * Possible send_group_sigqueue and
+ * send_sigqueue return values are as follows;
*
- * <command>0</command> -- The signal was either sucessfully added into the
- * <command>sigqueue</command> of the receiving process, or a <command>SI_TIMER</command> entry is already
+ * 0 -- The signal was either sucessfully added into the
+ * sigqueue of the receiving process, or a SI_TIMER entry is already
* queued (in which case, the overrun count will be simply incremented).
*
- * <command>1</command> -- The signal was ignored by the receiving process.
+ * 1 -- The signal was ignored by the receiving process.
*
- * <command>-1</command> -- (<command>send_sigqueue</command> only) The task was marked
- * <command>exiting</command>, allowing * <command>posix_timer_event</command> to redirect it to the group
+ * -1 -- (send_sigqueue only) The task was marked
+ * exiting, allowing * posix_timer_event to redirect it to the group
* leader.
*
*/
@@ -242,9 +242,9 @@ probe _signal.send.part3.return = kernel.function("send_sigqueue").return
* @pid_name: Name of the process receiving the signal
* @si_code: Indicates the signal type
* @task: A task handle to the signal recipient
- * @sinfo: The address of the <command>siginfo</command> structure
+ * @sinfo: The address of the siginfo structure
* @name: Name of the probe point; default value is
- * <command>signal.checkperm</command>
+ * signal.checkperm
*/
probe signal.checkperm = kernel.function("check_kill_permission")
{
@@ -268,7 +268,7 @@ probe signal.checkperm = kernel.function("check_kill_permission")
/**
* probe signal.checkperm.return - Check performed on a sent signal completed
* @name: Name of the probe point; default value is
- * <command>signal.checkperm</command>
+ * signal.checkperm
* @retstr: Return value as a string
*/
probe signal.checkperm.return = kernel.function("check_kill_permission").return
@@ -283,11 +283,11 @@ probe signal.checkperm.return = kernel.function("check_kill_permission").return
* @sig_pid: The PID of the process to wake
* @pid_name: Name of the process to wake
* @resume: Indicates whether to wake up a task in a
- * <command>STOPPED</command> or <command>TRACED</command> state
+ * STOPPED or TRACED state
* @state_mask: A string representation indicating the mask
* of task states to wake. Possible values are
- * <command>TASK_INTERRUPTIBLE</command>, <command>TASK_STOPPED</command>,
- * <command>TASK_TRACED</command>, and <command>TASK_INTERRUPTIBLE</command>.
+ * TASK_INTERRUPTIBLE, TASK_STOPPED,
+ * TASK_TRACED, and TASK_INTERRUPTIBLE.
*/
probe signal.wakeup = kernel.function("signal_wake_up")
{
@@ -320,7 +320,7 @@ probe signal.check_ignored = kernel.function("sig_ignored")
/**
* probe signal.check_ignored.return - Check to see signal is ignored completed
* @name: Name of the probe point; default value is
- * <command>signal.checkperm</command>
+ * signal.checkperm
* @retstr: Return value as a string
*/
probe signal.check_ignored.return = kernel.function("sig_ignored").return ?
@@ -348,7 +348,7 @@ probe signal.handle_stop = kernel.function("handle_stop_signal")
/**
- * probe signal.force_segv - Forcing send of <command>SIGSEGV</command>
+ * probe signal.force_segv - Forcing send of SIGSEGV
* @sig_pid: The PID of the process receiving the signal
* @pid_name: Name of the process receiving the signal
* @sig: The number of the signal
@@ -375,9 +375,9 @@ probe _signal.force_segv.part2 = kernel.function("force_sigsegv_info") ?
}
/**
- * probe signal.force_segv.return - Forcing send of <command>SIGSEGV</command> complete
+ * probe signal.force_segv.return - Forcing send of SIGSEGV complete
* @name: Name of the probe point; default value is
- * <command>force_sigsegv</command>
+ * force_sigsegv
* @retstr: Return value as a string
*/
probe signal.force_segv.return =
@@ -412,7 +412,7 @@ probe signal.syskill.return = syscall.kill.return
* @sig: The specific signal sent to the process
* @sig_name: The specific signal sent to the process
*
- * The <command>tkill</command> call is analogous to <command>kill(2)</command>,
+ * The tkill call is analogous to kill(2),
* except that it also allows a process within a specific thread group to
* be targeted. Such processes are targeted through their unique
* thread IDs (TID).
@@ -436,7 +436,7 @@ probe signal.systkill.return = syscall.tkill.return
* @sig: The specific kill signal sent to the process
* @sig_name: A string representation of the signal
*
- * The <command>tgkill</command> call is similar to <command>tkill</command>,
+ * The tgkill call is similar to tkill,
* except that it also allows the caller to specify the thread group ID of
* the thread to be signalled. This protects against TID reuse.
*/
@@ -486,12 +486,12 @@ probe signal.send_sig_queue.return =
/**
* probe signal.pending - Examining pending signal
* @sigset_add: The address of the user-space signal set
- * (<command>sigset_t</command>)
+ * (sigset_t)
* @sigset_size: The size of the user-space signal set
*
* This probe is used to examine a set of signals pending for delivery
* to a specific thread. This normally occurs when the
- * <command>do_sigpending</command> kernel function is executed.
+ * do_sigpending kernel function is executed.
*/
probe signal.pending = kernel.function("do_sigpending")
{
@@ -512,10 +512,10 @@ probe signal.pending.return = kernel.function("do_sigpending").return
/**
* probe signal.handle - Signal handler being invoked
* @sig: The signal number that invoked the signal handler
- * @sinfo: The address of the <command>siginfo</command> table
- * @sig_code: The <command>si_code</command> value of the
- * <command>siginfo</command> signal
- * @ka_addr: The address of the <command>k_sigaction</command> table
+ * @sinfo: The address of the siginfo table
+ * @sig_code: The si_code value of the
+ * siginfo signal
+ * @ka_addr: The address of the k_sigaction table
* associated with the signal
* @oldset_addr: The address of the bitmask array of blocked signals
* @regs: The address of the kernel-mode stack area
@@ -552,9 +552,9 @@ probe signal.handle.return = kernel.function("handle_signal").return ?
/**
* probe signal.do_action - Examining or changing a signal action
* @sig: The signal to be examined/changed
- * @sigact_addr: The address of the new <command>sigaction</command>
+ * @sigact_addr: The address of the new sigaction
* struct associated with the signal
- * @oldsigact_addr: The address of the old <command>sigaction</command>
+ * @oldsigact_addr: The address of the old sigaction
* struct associated with the signal
* @sa_handler: The new handler of the signal
* @sa_mask: The new mask of the signal
@@ -596,15 +596,15 @@ function __get_action_mask:long(act:long) %{ /* pure */
/**
* probe signal.procmask - Examining or changing blocked signals
* @how: Indicates how to change the blocked signals; possible values are
- * <command>SIG_BLOCK=0</command> (for blocking signals),
- * <command>SIG_UNBLOCK=1</command> (for unblocking signals), and
- * <command>SIG_SETMASK=2</command> for setting the signal mask.
- * @sigset_addr: The address of the signal set (<command>sigset_t</command>)
+ * SIG_BLOCK=0 (for blocking signals),
+ * SIG_UNBLOCK=1 (for unblocking signals), and
+ * SIG_SETMASK=2 for setting the signal mask.
+ * @sigset_addr: The address of the signal set (sigset_t)
* to be implemented
* @oldsigset_addr: The old address of the signal set
- * (<command>sigset_t</command>)
- * @sigset: The actual value to be set for <command>sigset_t</command>
- * <remark>(correct?)</remark>
+ * (sigset_t)
+ * @sigset: The actual value to be set for sigset_t
+ * (correct?)
*/
probe signal.procmask = kernel.function("sigprocmask")
{