summaryrefslogtreecommitdiffstats
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
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.
-rwxr-xr-xconfigure2
-rw-r--r--configure.ac6
-rw-r--r--doc/SystemTap_Tapset_Reference/Makefile.am8
-rw-r--r--doc/SystemTap_Tapset_Reference/Makefile.in7
-rw-r--r--tapset/context-symbols.stp2
-rw-r--r--tapset/context-unwind.stp6
-rw-r--r--tapset/context.stp11
-rw-r--r--tapset/kprocess.stp2
-rw-r--r--tapset/memory.stp28
-rw-r--r--tapset/signal.stp100
-rw-r--r--tapset/socket.stp2
-rw-r--r--tapset/ucontext-symbols.stp2
-rw-r--r--tapset/ucontext-unwind.stp2
13 files changed, 90 insertions, 88 deletions
diff --git a/configure b/configure
index a7055140..537aa211 100755
--- a/configure
+++ b/configure
@@ -6826,7 +6826,7 @@ $as_echo "no" >&6; }
$as_echo "$as_me: WARNING: Not building reference documentation in PDF format" >&2;}
fi
fi
- if test "have_xmlto_pdf" == "yes"; then
+ if test "maybe later" == "yes"; then
BUILD_PDFREFDOCS_TRUE=
BUILD_PDFREFDOCS_FALSE='#'
else
diff --git a/configure.ac b/configure.ac
index 5d2a010d..c40875f6 100644
--- a/configure.ac
+++ b/configure.ac
@@ -227,7 +227,11 @@ EOF
AC_MSG_WARN([Not building reference documentation in PDF format])
fi
fi
-AM_CONDITIONAL([BUILD_PDFREFDOCS], [test "have_xmlto_pdf" == "yes"])
+dnl Unfortunately https://bugzilla.redhat.com/show_bug.cgi?id=526273
+dnl blocks "xmlto pdf" on our docs (but not on the above test).
+dnl So we need to disable this anyway.
+dnl AM_CONDITIONAL([BUILD_PDFREFDOCS], [test "$have_xmlto_pdf" == "yes"])
+AM_CONDITIONAL([BUILD_PDFREFDOCS], [test "maybe later" == "yes"])
dnl Handle the option to build the server setup.
AC_ARG_ENABLE([server],
diff --git a/doc/SystemTap_Tapset_Reference/Makefile.am b/doc/SystemTap_Tapset_Reference/Makefile.am
index 4adba34e..bd1bb18f 100644
--- a/doc/SystemTap_Tapset_Reference/Makefile.am
+++ b/doc/SystemTap_Tapset_Reference/Makefile.am
@@ -22,6 +22,8 @@ if BUILD_PDFREFDOCS
PDFDOCS = tapsets.pdf
endif
+XMLTOMANPARAMS=--stringparam man.authors.section.enabled=0 --stringparam man.copyright.section.enabled=0
+
if BUILD_REFDOCS
all: $(PDFDOCS) stamp-htmldocs stamp-mandocs
tapsets.xml: docproc $(shell find $(SRCTREE)/tapset -name '*.stp')
@@ -34,15 +36,15 @@ tapsets.xml: docproc $(shell find $(SRCTREE)/tapset -name '*.stp')
fi
stamp-htmldocs: tapsets.xml
- xmlto html -o tapsets tapsets.xml
+ xmlto $(XMLTOHTMLPARAMS) html -o tapsets tapsets.xml
touch stamp-htmldocs
# bump up the allocated space so "xmlto pdf" works
tapsets.pdf: tapsets.xml
- env pool_size=2000000 hash_extra=2000000 xmlto pdf tapsets.xml
+ env pool_size=2000000 hash_extra=2000000 xmlto $(XMLTOPDFPARAMS) pdf tapsets.xml
stamp-mandocs: tapsets.xml
- xmlto man -o man3 tapsets.xml
+ xmlto $(XMLTOMANPARAMS) man -o man3 tapsets.xml
touch stamp-mandocs
#FIXME need to figure out where to install things appropriately
diff --git a/doc/SystemTap_Tapset_Reference/Makefile.in b/doc/SystemTap_Tapset_Reference/Makefile.in
index 66822d7b..b2529891 100644
--- a/doc/SystemTap_Tapset_Reference/Makefile.in
+++ b/doc/SystemTap_Tapset_Reference/Makefile.in
@@ -186,6 +186,7 @@ HTML_INSTALL_DIR = $(DESTDIR)$(datadir)/doc/systemtap/tapsets
SRCTREE = $(abs_top_srcdir)/
DOCPROC = $(abs_builddir)/docproc
@BUILD_PDFREFDOCS_TRUE@PDFDOCS = tapsets.pdf
+XMLTOMANPARAMS = --stringparam man.authors.section.enabled=0 --stringparam man.copyright.section.enabled=0
CLEANFILES = tapsets.xml stamp-* $(PDFDOCS)
all: all-am
@@ -461,15 +462,15 @@ uninstall-am:
@BUILD_REFDOCS_TRUE@ fi
@BUILD_REFDOCS_TRUE@stamp-htmldocs: tapsets.xml
-@BUILD_REFDOCS_TRUE@ xmlto html -o tapsets tapsets.xml
+@BUILD_REFDOCS_TRUE@ xmlto $(XMLTOHTMLPARAMS) html -o tapsets tapsets.xml
@BUILD_REFDOCS_TRUE@ touch stamp-htmldocs
# bump up the allocated space so "xmlto pdf" works
@BUILD_REFDOCS_TRUE@tapsets.pdf: tapsets.xml
-@BUILD_REFDOCS_TRUE@ env pool_size=2000000 hash_extra=2000000 xmlto pdf tapsets.xml
+@BUILD_REFDOCS_TRUE@ env pool_size=2000000 hash_extra=2000000 xmlto $(XMLTOPDFPARAMS) pdf tapsets.xml
@BUILD_REFDOCS_TRUE@stamp-mandocs: tapsets.xml
-@BUILD_REFDOCS_TRUE@ xmlto man -o man3 tapsets.xml
+@BUILD_REFDOCS_TRUE@ xmlto $(XMLTOMANPARAMS) man -o man3 tapsets.xml
@BUILD_REFDOCS_TRUE@ touch stamp-mandocs
#FIXME need to figure out where to install things appropriately
diff --git a/tapset/context-symbols.stp b/tapset/context-symbols.stp
index 3ec7a866..6cd4dcbb 100644
--- a/tapset/context-symbols.stp
+++ b/tapset/context-symbols.stp
@@ -23,7 +23,7 @@
*
* Perform a symbolic lookup of the addresses in the given string,
* which is assumed to be the result of a prior call to
- * <command>backtrace()</command>.
+ * backtrace().
*
* Print one line per address, including the address, the
* name of the function containing the address, and an estimate of
diff --git a/tapset/context-unwind.stp b/tapset/context-unwind.stp
index 33431fd0..741031c0 100644
--- a/tapset/context-unwind.stp
+++ b/tapset/context-unwind.stp
@@ -23,7 +23,7 @@
/**
* sfunction print_backtrace - Print stack back trace
*
- * Equivalent to <command>print_stack(backtrace())</command>,
+ * Equivalent to print_stack(backtrace()),
* except that deeper stack nesting may be supported. Return nothing.
*/
function print_backtrace () %{
@@ -66,7 +66,7 @@ function task_backtrace:string (task:long) %{ /* pure */
* Return the address and name of the calling function.
* This is equivalent to calling:
* sprintf("%s 0x%x", symname(caller_addr(), caller_addr()))
- * <emphasis>Works only for return probes at this time.</emphasis>
+ * Works only for return probes at this time.
*/
function caller:string() {
return sprintf("%s 0x%x", symname(caller_addr()), caller_addr());
@@ -76,7 +76,7 @@ function caller:string() {
* sfunction caller_addr - Return caller address
*
* Return the address of the calling function.
- * <emphasis> Works only for return probes at this time.</emphasis>
+ * Works only for return probes at this time.
*/
function caller_addr:long () %{ /* pure */
if (CONTEXT->pi)
diff --git a/tapset/context.stp b/tapset/context.stp
index 226e3ee5..14128589 100644
--- a/tapset/context.stp
+++ b/tapset/context.stp
@@ -182,11 +182,11 @@ function pp:string () %{ /* pure */ /* unprivileged */
%}
/**
- * sfunction registers_valid - Determines validity of <command>register()</command> and <command>u_register()</command> in current context.
+ * sfunction registers_valid - Determines validity of register() and u_register() in current context.
*
* Return 1 if register() and u_register() can be used
* in the current context, or 0 otherwise.
- * For example, <command>registers_valid()</command> returns 0
+ * For example, registers_valid() returns 0
* when called from a begin or end probe.
*/
function registers_valid:long () %{ /* pure */ /* unprivileged */
@@ -210,12 +210,7 @@ function user_mode:long () %{ /* pure */ /* unprivileged */
}
%}
-/**
- * sfunction is_return - Determines if probe point is a return probe.
- *
- * Return 1 if the probe point is a return probe.
- * <emphasis>Deprecated.</emphasis>
- */
+
function is_return:long () %{ /* pure */
if (CONTEXT->pi)
THIS->__retvalue = 1;
diff --git a/tapset/kprocess.stp b/tapset/kprocess.stp
index 316e03ce..02b4dce2 100644
--- a/tapset/kprocess.stp
+++ b/tapset/kprocess.stp
@@ -22,7 +22,7 @@ function _IS_ERR:long(ptr:long) %{ /* pure */
* Parent of the created process.
*
* Fires whenever a new process is successfully created, either as a result of
- * <command>fork</command> (or one of its syscall variants), or a new kernel thread.
+ * fork (or one of its syscall variants), or a new kernel thread.
*/
probe kprocess.create = kernel.function("copy_process").return {
task = $return
diff --git a/tapset/memory.stp b/tapset/memory.stp
index a855fbcb..c6d3ec8f 100644
--- a/tapset/memory.stp
+++ b/tapset/memory.stp
@@ -57,8 +57,8 @@ function vm_fault_contains:long (value:long, test:long)
/**
* probe vm.pagefault - Records that a page fault occurred.
* @address: The address of the faulting memory access; i.e. the address that caused the page fault.
- * @write_access: Indicates whether this was a write or read access; <command>1</command> indicates a write,
- * while <command>0</command> indicates a read.
+ * @write_access: Indicates whether this was a write or read access; 1 indicates a write,
+ * while 0 indicates a read.
*
* Context: The process which triggered the fault
*/
@@ -76,9 +76,9 @@ probe vm.pagefault = kernel.function("__handle_mm_fault@mm/memory.c") ?,
/**
* probe vm.pagefault.return - Indicates what type of fault occurred.
* @fault_type: Returns either
- * <command>0</command> (VM_FAULT_OOM) for out of memory faults,
- * <command>2</command> (VM_FAULT_MINOR) for minor faults, <command>3</command> (VM_FAULT_MAJOR) for
- * major faults, or <command>1</command> (VM_FAULT_SIGBUS) if the fault was neither OOM, minor fault,
+ * 0 (VM_FAULT_OOM) for out of memory faults,
+ * 2 (VM_FAULT_MINOR) for minor faults, 3 (VM_FAULT_MAJOR) for
+ * major faults, or 1 (VM_FAULT_SIGBUS) if the fault was neither OOM, minor fault,
* nor major fault.
*/
probe vm.pagefault.return = kernel.function("__handle_mm_fault@mm/memory.c").return ?,
@@ -120,7 +120,7 @@ function _IS_ZERO_PAGE:long(from:long, vaddr:long) %{ /* pure */
*
* Fires when a process attempts to write to a shared page.
* If a copy is necessary, this will be followed by a
- * <command>vm.write_shared_copy</command>.
+ * vm.write_shared_copy.
*/
probe vm.write_shared = kernel.function("do_wp_page") {
address = $address
@@ -136,7 +136,7 @@ probe vm.write_shared = kernel.function("do_wp_page") {
* 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>.
+ * always preceded by a vm.shared_write.
*/
probe vm.write_shared_copy = kernel.function("copy_cow_page")? {
address = $address
@@ -145,12 +145,12 @@ probe vm.write_shared_copy = kernel.function("copy_cow_page")? {
/**
- * probe vm.mmap - Fires when an <command>mmap</command> is requested.
+ * probe vm.mmap - Fires when an mmap is requested.
* @address: The requested address
* @length: The length of the memory segment
*
* Context:
- * The process calling <command>mmap</command>.
+ * The process calling mmap.
*/
probe vm.mmap = kernel.function("do_mmap"), kernel.function("do_mmap2")? {
address = $addr
@@ -159,12 +159,12 @@ probe vm.mmap = kernel.function("do_mmap"), kernel.function("do_mmap2")? {
/**
- * probe vm.munmap - Fires when an <command>munmap</command> is requested.
+ * probe vm.munmap - Fires when an munmap is requested.
* @address: The requested address
* @length: The length of the memory segment
*
* Context:
- * The process calling <command>munmap</command>.
+ * The process calling munmap.
*/
probe vm.munmap = kernel.function("do_munmap") {
address = $start
@@ -172,12 +172,12 @@ probe vm.munmap = kernel.function("do_munmap") {
}
/**
- * probe vm.brk - Fires when a <command>brk</command> is requested (i.e. the heap will be resized).
+ * probe vm.brk - Fires when a brk is requested (i.e. the heap will be resized).
* @address: The requested address
* @length: The length of the memory segment
*
* Context:
- * The process calling <command>brk</command>.
+ * The process calling brk.
*/
probe vm.brk = kernel.function("do_brk") {
address = $addr
@@ -190,7 +190,7 @@ probe vm.brk = kernel.function("do_brk") {
*
* Context:
* The process that tried to consume excessive memory, and thus
- * triggered the OOM. <remark>(is this correct?)</remark>
+ * triggered the OOM.
*/
probe vm.oom_kill = kernel.function("__oom_kill_task") {
task = $p
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")
{
diff --git a/tapset/socket.stp b/tapset/socket.stp
index b4d4981c..d361602a 100644
--- a/tapset/socket.stp
+++ b/tapset/socket.stp
@@ -95,7 +95,7 @@ probe socket.sendmsg = kernel.function ("sock_sendmsg")
}
/**
- * probe socket.sendmsg.return - Return from <command>socket.sendmsg</command>.
+ * probe socket.sendmsg.return - Return from socket.sendmsg.
* @name: Name of this probe
* @size: Size of message sent (in bytes) or error code if success = 0
* @protocol: Protocol value
diff --git a/tapset/ucontext-symbols.stp b/tapset/ucontext-symbols.stp
index 574a32be..2f73768b 100644
--- a/tapset/ucontext-symbols.stp
+++ b/tapset/ucontext-symbols.stp
@@ -58,7 +58,7 @@ function usymdata:string (addr: long) %{ /* pure */ /* unprivileged */
*
* Perform a symbolic lookup of the addresses in the given string,
* which is assumed to be the result of a prior call to
- * <command>ubacktrace()</command> for the current task.
+ * ubacktrace() for the current task.
*
* Print one line per address, including the address, the
* name of the function containing the address, and an estimate of
diff --git a/tapset/ucontext-unwind.stp b/tapset/ucontext-unwind.stp
index e1a8ade3..d699e588 100644
--- a/tapset/ucontext-unwind.stp
+++ b/tapset/ucontext-unwind.stp
@@ -21,7 +21,7 @@
/**
* sfunction print_ubacktrace - Print stack back trace for current task. EXPERIMENTAL!
*
- * Equivalent to <command>print_ustack(ubacktrace())</command>,
+ * Equivalent to print_ustack(ubacktrace()),
* except that deeper stack nesting may be supported. Return nothing.
*/
function print_ubacktrace () %{ /* unprivileged */