From 7a18a12684f498929b5938ceb18f66b18d2e1fe3 Mon Sep 17 00:00:00 2001 From: "Frank Ch. Eigler" Date: Tue, 29 Sep 2009 14:09:32 -0400 Subject: tapset docs cleanup Several problems: some invalid 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. --- tapset/signal.stp | 100 +++++++++++++++++++++++++++--------------------------- 1 file changed, 50 insertions(+), 50 deletions(-) (limited to 'tapset/signal.stp') 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 siginfo 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 - * sigqueue + * 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 __group_send_sig_info, - * specific_send_sig_info, - * or send_sigqueue + * @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 sigqueue + * existing sigqueue * @name: The name of the function used to send out the signal * * Context: - * The signal's sender. (correct?) + * The signal's sender. (correct?) * - * Possible __group_send_sig_info and - * specific_send_sig_info return values are as follows; + * Possible __group_send_sig_info and + * specific_send_sig_info return values are as follows; * - * 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. + * 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. * - * -EAGAIN -- The sigqueue 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 kill(). + * than kill(). * - * Possible send_group_sigqueue and - * send_sigqueue return values are as follows; + * Possible send_group_sigqueue and + * send_sigqueue return values are as follows; * - * 0 -- The signal was either sucessfully added into the - * sigqueue of the receiving process, or a SI_TIMER 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). * - * 1 -- The signal was ignored by the receiving process. + * 1 -- The signal was ignored by the receiving process. * - * -1 -- (send_sigqueue only) The task was marked - * exiting, allowing * posix_timer_event 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 siginfo structure + * @sinfo: The address of the siginfo structure * @name: Name of the probe point; default value is - * signal.checkperm + * 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 - * signal.checkperm + * 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 - * STOPPED or TRACED state + * STOPPED or TRACED state * @state_mask: A string representation indicating the mask * of task states to wake. Possible values are - * TASK_INTERRUPTIBLE, TASK_STOPPED, - * TASK_TRACED, and TASK_INTERRUPTIBLE. + * 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 - * signal.checkperm + * 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 SIGSEGV + * 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 SIGSEGV complete + * probe signal.force_segv.return - Forcing send of SIGSEGV complete * @name: Name of the probe point; default value is - * force_sigsegv + * 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 tkill call is analogous to kill(2), + * 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 tgkill call is similar to tkill, + * 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 - * (sigset_t) + * (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 - * do_sigpending 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 siginfo table - * @sig_code: The si_code value of the - * siginfo signal - * @ka_addr: The address of the k_sigaction 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 sigaction + * @sigact_addr: The address of the new sigaction * struct associated with the signal - * @oldsigact_addr: The address of the old sigaction + * @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 - * 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) + * 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 - * (sigset_t) - * @sigset: The actual value to be set for sigset_t - * (correct?) + * (sigset_t) + * @sigset: The actual value to be set for sigset_t + * (correct?) */ probe signal.procmask = kernel.function("sigprocmask") { -- cgit