From: Josh Stone Date: Thu, 2 Aug 2012 19:38:27 +0000 (-0700) Subject: PR14180: Fix tapset documentation for non-root tapsets X-Git-Tag: release-2.0~218 X-Git-Url: https://sourceware.org/git/?a=commitdiff_plain;h=4bfad28d7f2fd685871d1ba6abbe723ad919fe25;p=systemtap.git PR14180: Fix tapset documentation for non-root tapsets * doc/SystemTap_Tapset_Reference/manpager: Use basenames so we can deal with tapsets that are from a subdirectory, like tapset/linux/. * doc/SystemTap_Tapset_Reference/tapsets.tmpl: Update !I paths for the many tapsets that moved in commit d3110553. * tapset/linux/context.stp: Defer to tapset/context.stp --- diff --git a/doc/SystemTap_Tapset_Reference/manpager b/doc/SystemTap_Tapset_Reference/manpager index adf514261..30e9571d3 100755 --- a/doc/SystemTap_Tapset_Reference/manpager +++ b/doc/SystemTap_Tapset_Reference/manpager @@ -23,10 +23,15 @@ cat $SRCTREE/doc/SystemTap_Tapset_Reference/tapsets.tmpl | grep ^\!Itapset > ma sed -i -e 's/\!Itapset\///g' manpageus ; # copy list of man pages into working directory +# with similar basenames concatenated for i in `cat manpageus` ; do - cp $SRCTREE/tapset/$i workingdir ; + b=`basename $i` + cat $SRCTREE/tapset/$i >>workingdir/$b ; done ; +# rewrite manpageus to the resulting files +ls workingdir >manpageus + # enter workdir cd workingdir ; diff --git a/doc/SystemTap_Tapset_Reference/tapsets.tmpl b/doc/SystemTap_Tapset_Reference/tapsets.tmpl index 025a24f49..9ed01071a 100644 --- a/doc/SystemTap_Tapset_Reference/tapsets.tmpl +++ b/doc/SystemTap_Tapset_Reference/tapsets.tmpl @@ -117,16 +117,17 @@ and the current register values for the processor. !Itapset/context.stp -!Itapset/context-envvar.stp -!Itapset/context-symbols.stp -!Itapset/ucontext.stp -!Itapset/ucontext-symbols.stp -!Itapset/context-unwind.stp -!Itapset/context-caller.stp -!Itapset/ucontext-unwind.stp -!Itapset/task.stp +!Itapset/linux/context.stp +!Itapset/linux/context-envvar.stp +!Itapset/linux/context-symbols.stp +!Itapset/linux/ucontext.stp +!Itapset/linux/ucontext-symbols.stp +!Itapset/linux/context-unwind.stp +!Itapset/linux/context-caller.stp +!Itapset/linux/ucontext-unwind.stp +!Itapset/linux/task.stp !Itapset/pn.stp -!Itapset/pstrace.stp +!Itapset/linux/pstrace.stp !Itapset/registers.stp @@ -139,9 +140,9 @@ when an event occurred, provide an ordering for events, or compute the amount of time elapsed between two time stamps. -!Itapset/timestamp.stp -!Itapset/timestamp_gtod.stp -!Itapset/timestamp_monotonic.stp +!Itapset/linux/timestamp.stp +!Itapset/linux/timestamp_gtod.stp +!Itapset/linux/timestamp_monotonic.stp !Itapset/stopwatch.stp @@ -152,7 +153,7 @@ the timestamp function gettimeofday_s()) into a human readable date/time strings. -!Itapset/ctime.stp +!Itapset/linux/ctime.stp !Itapset/tzinfo.stp @@ -172,8 +173,8 @@ or query the memory usage of the current process. It contains the following probe points: -!Itapset/memory.stp -!Itapset/proc_mem.stp +!Itapset/linux/memory.stp +!Itapset/linux/proc_mem.stp @@ -183,7 +184,7 @@ properties of the current tasks, translate those in miliseconds and human readable strings. -!Itapset/task_time.stp +!Itapset/linux/task_time.stp @@ -192,7 +193,7 @@ This family of probe points is used to probe the task scheduler activities. It contains the following probe points: -!Itapset/scheduler.stp +!Itapset/linux/scheduler.stp @@ -201,8 +202,8 @@ This family of probe points is used to probe block IO layer and IO scheduler activities. It contains the following probe points: -!Itapset/ioscheduler.stp -!Itapset/ioblock.stp +!Itapset/linux/ioscheduler.stp +!Itapset/linux/ioblock.stp @@ -211,7 +212,7 @@ This family of probe points is used to probe SCSI activities. It contains the following probe points: -!Itapset/scsi.stp +!Itapset/linux/scsi.stp @@ -220,7 +221,7 @@ This family of probe points is used to probe TTY (Teletype) activities. It contains the following probe points: -!Itapset/tty.stp +!Itapset/linux/tty.stp @@ -230,7 +231,7 @@ (IRQ) activities. It contains the following probe points: -!Itapset/irq.stp +!Itapset/linux/irq.stp @@ -239,13 +240,13 @@ This family of probe points is used to probe the activities of the network device and protocol layers. -!Itapset/networking.stp -!Itapset/tcp.stp -!Itapset/udp.stp -!Itapset/ip.stp -!Itapset/inet.stp -!Itapset/rpc.stp -!Itapset/netfilter.stp +!Itapset/linux/networking.stp +!Itapset/linux/tcp.stp +!Itapset/linux/udp.stp +!Itapset/linux/ip.stp +!Itapset/linux/inet.stp +!Itapset/linux/rpc.stp +!Itapset/linux/netfilter.stp @@ -254,8 +255,8 @@ This family of probe points is used to probe socket activities. It contains the following probe points: -!Itapset/socket.stp -!Itapset/inet_sock.stp +!Itapset/linux/socket.stp +!Itapset/linux/inet_sock.stp SNMP Information Tapset @@ -264,12 +265,12 @@ provide SNMP type information. It contains the following functions and probe points: -!Itapset/ipmib.stp -!Itapset/ipmib-filter-default.stp -!Itapset/tcpmib.stp -!Itapset/tcpmib-filter-default.stp -!Itapset/linuxmib.stp -!Itapset/linuxmib-filter-default.stp +!Itapset/linux/ipmib.stp +!Itapset/linux/ipmib-filter-default.stp +!Itapset/linux/tcpmib.stp +!Itapset/linux/tcpmib-filter-default.stp +!Itapset/linux/linuxmib.stp +!Itapset/linux/linuxmib-filter-default.stp Kernel Process Tapset @@ -277,8 +278,8 @@ This family of probe points is used to probe process-related activities. It contains the following probe points: -!Itapset/kprocess.stp -!Itapset/target_set.stp +!Itapset/linux/kprocess.stp +!Itapset/linux/target_set.stp Signal Tapset @@ -286,7 +287,7 @@ This family of probe points is used to probe signal activities. It contains the following probe points: -!Itapset/signal.stp +!Itapset/linux/signal.stp Errno Tapset @@ -302,7 +303,7 @@ This set of functions is used to handle kernel and userspace device numbers. It contains the following functions: -!Itapset/dev.stp +!Itapset/linux/dev.stp Directory-entry (dentry) Tapset @@ -310,7 +311,7 @@ This family of functions is used to map kernel VFS directory entry pointers to file or full path names. -!Itapset/dentry.stp +!Itapset/linux/dentry.stp Logging Tapset @@ -319,6 +320,7 @@ message strings to various destinations. !Itapset/logging.stp +!Itapset/linux/logging.stp Queue Statistics Tapset @@ -341,9 +343,9 @@ the kernel or a user space programs based on addresses. All strings are of a maximum length given by MAXSTRINGLEN. -!Itapset/conversions.stp -!Itapset/atomic.stp -!Itapset/uconversions.stp +!Itapset/linux/conversions.stp +!Itapset/linux/atomic.stp +!Itapset/linux/uconversions.stp @@ -356,7 +358,7 @@ memory. All the functions in this tapset require the use of guru mode (-g). -!Itapset/conversions-guru.stp +!Itapset/linux/conversions-guru.stp @@ -367,8 +369,8 @@ All the functions in this tapset require the use of guru mode (-g). -!Itapset/guru-delay.stp -!Itapset/panic.stp +!Itapset/linux/guru-delay.stp +!Itapset/linux/panic.stp @@ -411,10 +413,10 @@ This family of probe points is used to probe network file storage functions and operations. -!Itapset/nfs_proc.stp -!Itapset/nfs.stp -!Itapset/nfsd.stp -!Itapset/nfsderrno.stp +!Itapset/linux/nfs_proc.stp +!Itapset/linux/nfs.stp +!Itapset/linux/nfsd.stp +!Itapset/linux/nfsderrno.stp diff --git a/tapset/linux/context.stp b/tapset/linux/context.stp index 1b424d152..4b53b0e00 100644 --- a/tapset/linux/context.stp +++ b/tapset/linux/context.stp @@ -6,11 +6,8 @@ // redistribute it and/or modify it under the terms of the GNU General // Public License (GPL); either version 2, or (at your option) any // later version. -// -// Context functions provide additional information about where an event occurred. These functions can -//provide information such as a backtrace to where the event occurred and the current register values for the -//processor. -// +// +// NB: tapsetdescription is in tapset/context.stp /** * sfunction print_regs - Print a register dump