From 1c0f18a9730f1fa5990c79debfc1960b08c8b7cf Mon Sep 17 00:00:00 2001 From: William Cohen Date: Wed, 10 Dec 2008 14:49:46 -0500 Subject: Edit useful script examples. Clean up formating para-call-graph-simple.stp --- .../en-US/Useful_Scripts-iotime.xml | 15 +++++---- .../en-US/Useful_Scripts-nettop.xml | 13 +++++--- .../en-US/extras/para-callgraph-simple.stp | 36 +++++++++++----------- 3 files changed, 33 insertions(+), 31 deletions(-) (limited to 'doc') diff --git a/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-iotime.xml b/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-iotime.xml index 21b6db9d..7a1633aa 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-iotime.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-iotime.xml @@ -68,13 +68,12 @@ <xref linkend="iotime"/> Sample Output [...] -3123380 2460 (pcscd) access /dev/bus/usb/005/001 read: 0 write: 0 -825946 3364 (NetworkManager) access /sys/class/net/eth0/carrier read: 8190 write: 0 -825955 3364 (NetworkManager) iotime /sys/class/net/eth0/carrier time: 9 -117061 2460 (pcscd) access /dev/bus/usb/003/001 read: 43 write: 0 -117065 2460 (pcscd) iotime /dev/bus/usb/003/001 time: 7 -3973737 2886 (sendmail) access /proc/loadavg read: 4096 write: 0 -3973744 2886 (sendmail) iotime /proc/loadavg time: 11 +825946 3364 (NetworkManager) access /sys/class/net/eth0/carrier read: 8190 write: 0 +825955 3364 (NetworkManager) iotime /sys/class/net/eth0/carrier time: 9 +117061 2460 (pcscd) access /dev/bus/usb/003/001 read: 43 write: 0 +117065 2460 (pcscd) iotime /dev/bus/usb/003/001 time: 7 +3973737 2886 (sendmail) access /proc/loadavg read: 4096 write: 0 +3973744 2886 (sendmail) iotime /proc/loadavg time: 11 [...] @@ -137,4 +136,4 @@ print("\n") } --> - \ No newline at end of file + diff --git a/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-nettop.xml b/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-nettop.xml index c51d4b66..2d7e3595 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-nettop.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-nettop.xml @@ -63,20 +63,23 @@ if/else conditionals, alternative syntax examples of SystemTap scripts -Note that function print_activity() uses the following constructs: +Note that function print_activity() uses the following +expressions: -n_xmit ? @sum(ifxmit[pid, dev, exec, uid])/1024 : 0, +n_xmit ? @sum(ifxmit[pid, dev, exec, uid])/1024 : 0 n_recv ? @sum(ifrecv[pid, dev, exec, uid])/1024 : 0 -These constructs are if/else conditionals. The first statement is simply a more concise way of writing: +These expressions are if/else conditionals. +The first statement is simply a more concise way of writing the following +psuedo code: if n_recv != 0 then - @sum(ifrecv[pid, dev, exec, uid])/1024 + @sum(ifrecv[pid, dev, exec, uid])/1024 else - 0 + 0 tracks which processes are generating network traffic on the system, and provides the following information about each process: diff --git a/doc/SystemTap_Beginners_Guide/en-US/extras/para-callgraph-simple.stp b/doc/SystemTap_Beginners_Guide/en-US/extras/para-callgraph-simple.stp index 17cf50a5..1a3e2e03 100755 --- a/doc/SystemTap_Beginners_Guide/en-US/extras/para-callgraph-simple.stp +++ b/doc/SystemTap_Beginners_Guide/en-US/extras/para-callgraph-simple.stp @@ -1,39 +1,39 @@ function trace(entry_p) { - if(tid() in trace) - printf("%s%s%s\n",thread_indent(entry_p), - (entry_p>0?"->":"<-"), - probefunc()) + if(tid() in trace) + printf("%s%s%s\n",thread_indent(entry_p), + (entry_p>0?"->":"<-"), + probefunc()) } global trace probe kernel.function(@1).call { - if (execname() == "stapio") next # skip our own helper process - trace[tid()] = 1 - trace(1) + if (execname() == "stapio") next # skip our own helper process + trace[tid()] = 1 + trace(1) } probe kernel.function(@1).return { - trace(-1) - delete trace[tid()] + trace(-1) + delete trace[tid()] } probe kernel.function(@2).call { trace(1) } probe kernel.function(@2).return { trace(-1) } function trace(entry_p) { - if(tid() in trace) - printf("%s%s%s\n",thread_indent(entry_p), - (entry_p>0?"->":"<-"), - probefunc()) + if(tid() in trace) + printf("%s%s%s\n",thread_indent(entry_p), + (entry_p>0?"->":"<-"), + probefunc()) } global trace probe kernel.function(@1).call { - if (execname() == "stapio") next # skip our own helper process - trace[tid()] = 1 - trace(1) + if (execname() == "stapio") next # skip our own helper process + trace[tid()] = 1 + trace(1) } probe kernel.function(@1).return { - trace(-1) - delete trace[tid()] + trace(-1) + delete trace[tid()] } probe kernel.function(@2).call { trace(1) } -- cgit From 9a701ca695c885e9524a5f9488e1fc952d325f54 Mon Sep 17 00:00:00 2001 From: William Cohen Date: Wed, 10 Dec 2008 14:54:14 -0500 Subject: Clean up formatting iotime-simple.stp --- doc/SystemTap_Beginners_Guide/en-US/extras/iotime-simple.stp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/SystemTap_Beginners_Guide/en-US/extras/iotime-simple.stp b/doc/SystemTap_Beginners_Guide/en-US/extras/iotime-simple.stp index a14f7731..a16ee4a2 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/extras/iotime-simple.stp +++ b/doc/SystemTap_Beginners_Guide/en-US/extras/iotime-simple.stp @@ -68,10 +68,10 @@ probe syscall.write.return { probe syscall.close { if (filehandles[pid(), $fd] != "") { printf("%d %s access %s read: %d write: %d\n", timestamp(), proc(), - filehandles[pid(), $fd], fileread[pid(), $fd], filewrite[pid(), $fd]) + filehandles[pid(), $fd], fileread[pid(), $fd], filewrite[pid(), $fd]) if (@count(time_io[pid(), $fd])) printf("%d %s iotime %s time: %d\n", timestamp(), proc(), - filehandles[pid(), $fd], @sum(time_io[pid(), $fd])) + filehandles[pid(), $fd], @sum(time_io[pid(), $fd])) } delete fileread[pid(), $fd] delete filewrite[pid(), $fd] @@ -79,4 +79,4 @@ probe syscall.close { delete fd_io[pid()] delete entry_io[pid()] delete time_io[pid(),$fd] -} \ No newline at end of file +} -- cgit From 744cf3ab2a4735510874646ac720b4b28701f16f Mon Sep 17 00:00:00 2001 From: William Cohen Date: Wed, 10 Dec 2008 15:22:53 -0500 Subject: Add information about default MAXNESTING and MAXACTION allowed. --- doc/SystemTap_Beginners_Guide/en-US/Errors.xml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/SystemTap_Beginners_Guide/en-US/Errors.xml b/doc/SystemTap_Beginners_Guide/en-US/Errors.xml index ffb70470..910ff510 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Errors.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Errors.xml @@ -807,6 +807,7 @@ An array containing aggregate values contains too many distinct key pairs at thi Too many levels of function call nesting were attempted. + The default nesting of function calls allowed is 10. @@ -843,7 +844,9 @@ An array containing aggregate values contains too many distinct key pairs at thi understainding SystemTap errors - The probe handler attempted to execute too many statements in the probe handler. + The probe handler attempted to execute too many statements in the + probe handler. The default number of actions allow in a probe handler + is 1000. -- cgit From c8c12f3cc2181a1964611af79d69b3ffef4e0d34 Mon Sep 17 00:00:00 2001 From: ddomingo Date: Thu, 11 Dec 2008 15:12:45 +1000 Subject: edited index terms as per wcohen --- .../en-US/Array-Operations.xml | 42 +- doc/SystemTap_Beginners_Guide/en-US/Arrays.xml | 24 +- .../en-US/ScriptConstructs.xml | 18 +- doc/SystemTap_Beginners_Guide/en-US/Scripts.xml | 1141 ++++++++++---------- .../en-US/Useful_Scripts-disktop.xml | 19 +- .../en-US/Useful_Scripts-iotime.xml | 22 + .../en-US/Useful_Scripts-traceio.xml | 17 + 7 files changed, 681 insertions(+), 602 deletions(-) (limited to 'doc') diff --git a/doc/SystemTap_Beginners_Guide/en-US/Array-Operations.xml b/doc/SystemTap_Beginners_Guide/en-US/Array-Operations.xml index 789bf607..bf496321 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Array-Operations.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Array-Operations.xml @@ -962,23 +962,23 @@ probe vfs.read array operations computing for statistical aggregates -count (integer extractor) +@count (integer extractor) operations computing for statistical aggregates -count (integer extractor) +@count (integer extractor) computing for statistical aggregates array operations -count (integer extractor) +@count (integer extractor) -count (integer extractor) + @count (integer extractor) computing for statistical aggregates array operations @@ -997,23 +997,23 @@ probe vfs.read array operations computing for statistical aggregates -sum (integer extractor) +@sum (integer extractor) operations computing for statistical aggregates -sum (integer extractor) +@sum (integer extractor) computing for statistical aggregates array operations -sum (integer extractor) +@sum (integer extractor) -sum (integer extractor) + @sum (integer extractor) computing for statistical aggregates array operations @@ -1033,23 +1033,23 @@ probe vfs.read array operations computing for statistical aggregates -min (integer extractor) +@min (integer extractor) operations computing for statistical aggregates -min (integer extractor) +@min (integer extractor) computing for statistical aggregates array operations -min (integer extractor) +@min (integer extractor) -min (integer extractor) + @min (integer extractor) computing for statistical aggregates array operations @@ -1069,23 +1069,23 @@ probe vfs.read array operations computing for statistical aggregates -max (integer extractor) +@max (integer extractor) operations computing for statistical aggregates -max (integer extractor) +@max (integer extractor) computing for statistical aggregates array operations -max (integer extractor) +@max (integer extractor) -max (integer extractor) + @max (integer extractor) computing for statistical aggregates array operations @@ -1105,23 +1105,23 @@ probe vfs.read array operations computing for statistical aggregates -avg (integer extractor) +@avg (integer extractor) operations computing for statistical aggregates -avg (integer extractor) +@avg (integer extractor) computing for statistical aggregates array operations -avg (integer extractor) +@avg (integer extractor) -avg (integer extractor) + @avg (integer extractor) computing for statistical aggregates array operations @@ -1163,7 +1163,7 @@ probe vfs.read } probe timer.s(3) { - foreach([var1,var2] in reads) + foreach([var1,var2] in reads) printf("%s (%d) : %d \n", var1, var2, @count(reads[var1,var2])) } diff --git a/doc/SystemTap_Beginners_Guide/en-US/Arrays.xml b/doc/SystemTap_Beginners_Guide/en-US/Arrays.xml index 63c3df04..ac320fcd 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Arrays.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Arrays.xml @@ -6,7 +6,7 @@ Associative Arrays arrays -introduction +associative arrays @@ -20,11 +20,13 @@ + associative arrays @@ -38,14 +40,14 @@ arrays - + associative arrays introduction @@ -58,14 +60,14 @@ arrays - + associative arrays introduction @@ -78,14 +80,14 @@ arrays - + associative arrays introduction @@ -99,13 +101,13 @@ Since associative arrays are normally processed in multiple probes (as we will demonstrate later), they are declared as global variables in the SystemTap script. The syntax for accessing an element in an associative array is similar to that of awk, and is as follows: - + associative arrays introduction @@ -131,14 +133,14 @@ Here, the array_name is any arbitrary name the array uses. The index_expression is used to refer to a specific unique key in the array. To illustrate, let us try to build an array named foo that specifies the ages of three people (i.e. the unique keys): tom, dick, and harry. To assign them the ages (i.e. associated values) of 23, 24, and 25 respectively, we'd use the following array statements: - + associative arrays introduction diff --git a/doc/SystemTap_Beginners_Guide/en-US/ScriptConstructs.xml b/doc/SystemTap_Beginners_Guide/en-US/ScriptConstructs.xml index a139015d..2550efce 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/ScriptConstructs.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/ScriptConstructs.xml @@ -45,7 +45,7 @@ -SystemTap handlers + SystemTap statements SystemTap handler constructs variables @@ -73,7 +73,7 @@ name, assign a value from a function or expression to it, and use it in an expre -SystemTap handlers + SystemTap statements SystemTap handler constructs global @@ -130,7 +130,7 @@ probe timer.jiffies(100) { count_jiffies ++ } -SystemTap handlers + SystemTap statements conditional statements @@ -153,7 +153,7 @@ You can do this by using conditionals in handlers. SystemTa -SystemTap handlers + SystemTap statements conditional statements if/else @@ -219,7 +219,7 @@ probe end -SystemTap handlers + SystemTap statements conditional statements while loops @@ -271,7 +271,7 @@ printf("goodbye world\n") -SystemTap handlers + SystemTap statements conditional statements for loops @@ -326,7 +326,7 @@ while (conditional) { -SystemTap handlers + SystemTap statements conditional statements conditional operators @@ -374,7 +374,7 @@ while (conditional) { -SystemTap handlers + SystemTap statements SystemTap handler constructs command-line arguments @@ -407,7 +407,7 @@ probe kernel.function(@1).return { } -SystemTap handlers + SystemTap statements SystemTap handler constructs variable notations diff --git a/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml b/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml index a0fc7d52..fe2e69f4 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml @@ -547,578 +547,599 @@ probe timer.s(4) -
- Systemtap Handler/Body - -Handlers -introduction - - Consider the following sample script: - -helloworld.stp - -probe begin -{ - printf ("hello world\n") - exit () -} - - - - - In , the event begin - (i.e. the start of the session) triggers the handler enclosed in - { }, which simply prints hello - world, then exits. - - - - Note - -Handlers -exit() - - - -exit() -Handlers - - - SystemTap scripts continue to run until the - exit() function executes. If the users wants to stop - the execution of the script, it can interrupted manually with - CtrlC. - - - - - printf ( ) Statements - - printf() - format strings - - - - The printf () statement is one of the simplest - functions for printing data. printf () can also be - used to display data using a wide variety of SystemTap functions in the - following format: - - - - - -printf ("format string\n", arguments) - - -printf() -format strings - - - -format strings -printf() - - - The format string specifies how - arguments should be printed. The format string - of simply instructs SystemTap to print - hello world, and contains no format specifiers. - - -printf() -format specifiers - - - -format specifiers -printf() - - - You can use the format specifiers %s (for strings) - and %d (for numbers) in format strings, depending on - your list of arguments. Format strings can have multiple format - specifiers, each matching a corresponding argument; multiple arguments - are delimited by a comma (,). - - - - Note - -printf() -syntax and format - - - -syntax and format -printf() - - -format and syntax -printf() - - Semantically, the SystemTap printf function is - very similar to its C language counterpart. The aforementioned syntax - and format for SystemTap's printf function is - identical to that of the C-style printf. - - - - To illustrate this, consider the following probe example: - - -variables-in-printf-statements.stp - -probe syscall.open -{ - printf ("%s(%d) open\n", execname(), pid()) -} - - - - - instructs SystemTap to probe all entries to - the system call open; for each event, it prints the - current execname() (a string with the executable name) and - pid() (the current process ID number), followed by the word - open. A snippet of this probe's output would look like: - - - editorial review: does a clarification that "format specifier1" is - to "argument1", "format specifier2" is to "argument2", or is this clear - enough? - - -vmware-guestd(2206) open -hald(2360) open -hald(2360) open -hald(2360) open -df(3433) open -df(3433) open -df(3433) open -hald(2360) open - - - - SystemTap Functions - -functions - - - -SystemTap script functions - - - - Handlers - handler functions - - - - handler functions - Handlers - - - - SystemTap supports a wide variety of functions that can be used as - printf () arguments. - uses the SystemTap functions execname() (name of the - process that called a kernel function/performed a system call) and - pid() (current process ID). - - - - is "handler function" an appropriate term? wcohen: use "SystemTap functions" to match up language in man pages - -Handlers -handler functions - - - The following is a list of commonly-used SystemTap functions: - - - - tid() - - -Handlers -handler functions -tid() - - - -handler functions -Handlers -tid() - - - -tid() -Handlers -handler functions - - - The ID of the current thread. - - - - - uid() - - -Handlers -handler functions -uid() - - - -handler functions -Handlers -uid() - - - -uid() -Handlers -handler functions - - The ID of the current user. - - - - - cpu() - - -Handlers -handler functions -cpu() - - - -handler functions -Handlers -cpu() - - - -cpu() -Handlers -handler functions - - The current CPU number. - - - - - gettimeofday_s() - - -Handlers -handler functions -gettimeofday_s() - - - -handler functions -Handlers -gettimeofday_s() - - - -gettimeofday_s() -Handlers -handler functions - - - The number of seconds since UNIX epoch (January 1, 1970). - - - - - ctime() - - - Convert number of seconds since UNIX epoch to date. - - - - - - - pp() - - -Handlers -handler functions -pp() - - - -handler functions -Handlers -pp() - - - -pp() -Handlers -handler functions - - A string describing the probe point currently being handled. - - - - - - thread_indent() - - -Handlers -handler functions -thread_indent() - - - -handler functions -Handlers -thread_indent() - - - -thread_indent() -Handlers -handler functions - +
+ Systemtap Handler/Body + + handlers + introduction + + Consider the following sample script: + + helloworld.stp + + probe begin + { + printf ("hello world\n") + exit () + } + + + - This particular function is quite useful, providing you with a way - to better organize your print results. The function takes one - argument, an indentation delta, which indicates how many - spaces to add or remove from a thread's "indentation counter". - It then returns a - string with some generic trace data along with an appropriate number - of indentation spaces. - - - - The generic data included in the returned string includes a - timestamp (number of microseconds since the - first call to thread_indent() by the thread), - a process name, and the thread ID. This allows you to - identify what functions were called, who called them, and the - duration of each function call. - - - - If call entries and exits immediately precede each other, it is easy - to match them. However, in most cases, after a first function call - entry is made several other call entries and exits may be made - before the first call exits. The indentation counter helps you match - an entry with its corresponding exit by indenting the next function - call if it is not the exit of the previous one. - + In , the event begin + (i.e. the start of the session) triggers the handler enclosed in + { }, which simply prints hello + world, then exits. + + + + Note + + functions (used in handlers) + exit() + - - Consider the following example on the use of - thread_indent(): - + + exit() + Handlers + + + SystemTap scripts continue to run until the + exit() function executes. If the users wants to stop + the execution of the script, it can interrupted manually with + CtrlC. + + + + + printf ( ) Statements + + printf() + format strings + -thread_indent.stp - -probe kernel.function("*@net/socket.c") -{ - printf ("%s -> %s\n", thread_indent(1), probefunc()) -} -probe kernel.function("*@net/socket.c").return -{ - printf ("%s <- %s\n", thread_indent(-1), probefunc()) -} - - - - - prints out the - thread_indent() and probe functions at each event - in the following format: + + The printf () statement is one of the simplest + functions for printing data. printf () can also be + used to display data using a wide variety of SystemTap functions in the + following format: + + - - 0 ftp(7223): -> sys_socketcall - 1159 ftp(7223): -> sys_socket - 2173 ftp(7223): -> __sock_create - 2286 ftp(7223): -> sock_alloc_inode - 2737 ftp(7223): <- sock_alloc_inode - 3349 ftp(7223): -> sock_alloc - 3389 ftp(7223): <- sock_alloc - 3417 ftp(7223): <- __sock_create - 4117 ftp(7223): -> sock_create - 4160 ftp(7223): <- sock_create - 4301 ftp(7223): -> sock_map_fd - 4644 ftp(7223): -> sock_map_file - 4699 ftp(7223): <- sock_map_file - 4715 ftp(7223): <- sock_map_fd - 4732 ftp(7223): <- sys_socket - 4775 ftp(7223): <- sys_socketcall - - -This sample output contains the following information: - - - The time (in microseconds) since the initial thread_ident() call for the thread (included in the string from thread_ident()). - The process name (and its corresponding ID) that made the function call (included in the string from thread_ident()). + + printf ("format string\n", arguments) + + + printf() + format strings + - An arrow signifying whether the call was an entry (<-) or an exit (->); the indentations help you match specific function call entries with their corresponding exits. + + format strings + printf() + + + The format string specifies how + arguments should be printed. The format string + of simply instructs SystemTap to print + hello world, and contains no format specifiers. + + + printf() + format specifiers + - The name of the function called by the process. - - -remember to add a reference later to "tapsets" from here, to clarify -that thread_indent is defined in tapsets as a special function of sorts + + format specifiers + printf() + + + You can use the format specifiers %s (for strings) + and %d (for numbers) in format strings, depending on + your list of arguments. Format strings can have multiple format + specifiers, each matching a corresponding argument; multiple arguments + are delimited by a comma (,). + + + + Note + + printf() + syntax and format + + + + syntax and format + printf() + + + format and syntax + printf() + + Semantically, the SystemTap printf function is + very similar to its C language counterpart. The aforementioned syntax + and format for SystemTap's printf function is + identical to that of the C-style printf. + + + + To illustrate this, consider the following probe example: + + + variables-in-printf-statements.stp + + probe syscall.open + { + printf ("%s(%d) open\n", execname(), pid()) + } + + - - - - - name - - -Handlers -handler functions -name - - - -handler functions -Handlers -name - - - -name -Handlers -handler functions - - Identifies the name of a specific system call. This variable can - only be used in probes that use the event - syscall.system_call. - - - - - - target() - - - -Handlers -handler functions -target() - - - -handler functions -Handlers -target() - - - -target() -Handlers -handler functions - - Used in conjunction with stap - script -x process - ID or stap - script -c - command. If you want to specify - a script to take an argument of a process ID or command, use - target() as the variable in the script to refer - to it. For example: - - - -targetexample.stp - -probe syscall.* { - if (pid() == target()) - printf("%s/n", name) -} - - - - - When is run with the argument - -x process ID, it - watches all system calls (as specified by the event - syscall.*) and prints out the name of all system - calls made by the specified process. - + instructs SystemTap to probe all entries to + the system call open; for each event, it prints the + current execname() (a string with the executable name) and + pid() (the current process ID number), followed by the word + open. A snippet of this probe's output would look like: + - - This has the same effect as specifying if (pid() == - process ID) each time you wish - to target a specific process. However, using - target() makes it easier for you to re-use the - script, giving you the ability to simply pass a process ID as an - argument each time you wish to run the script (e.g. stap - targetexample.stp -x process ID). - - - - - - - - - - For more information about supported SystemTap functions, refer to - man stapfuncs. - - -will need a complete listing of supported handler functions? also, SystemTap function descriptions seem ambiguous, please advise. - - - + + handler functions + + + + SystemTap supports a wide variety of functions that can be used as + printf () arguments. + uses the SystemTap functions execname() (name of the + process that called a kernel function/performed a system call) and + pid() (current process ID). + + + + is "handler function" an appropriate term? wcohen: use "SystemTap functions" to match up language in man pages + + The following is a list of commonly-used SystemTap functions: + + + + tid() + + + functions + handler functions + tid() + + + + handler functions + Handlers + tid() + + + + tid() + Handlers + handler functions + + + The ID of the current thread. + + + + + uid() + + + functions + handler functions + uid() + + + + handler functions + Handlers + uid() + + + + uid() + Handlers + handler functions + + The ID of the current user. + + + + + cpu() + + + functions + handler functions + cpu() + + + + handler functions + Handlers + cpu() + + + + cpu() + Handlers + handler functions + + The current CPU number. + + + + + gettimeofday_s() + + + functions + handler functions + gettimeofday_s() + + + + handler functions + Handlers + gettimeofday_s() + + + + gettimeofday_s() + Handlers + handler functions + + + The number of seconds since UNIX epoch (January 1, 1970). + + + + + ctime() + + + functions + handler functions + ctime() + + + + handler functions + Handlers + ctime() + + + + ctime() + Handlers + handler functions + + + Convert number of seconds since UNIX epoch to date. + + + + + + + + pp() + + + functions + handler functions + pp() + + + + handler functions + Handlers + pp() + + + + pp() + Handlers + handler functions + + A string describing the probe point currently being handled. + + + + + + thread_indent() + + + functions + handler functions + thread_indent() + + + + handler functions + Handlers + thread_indent() + + + + thread_indent() + Handlers + handler functions + + + This particular function is quite useful, providing you with a way + to better organize your print results. The function takes one + argument, an indentation delta, which indicates how many + spaces to add or remove from a thread's "indentation counter". + It then returns a + string with some generic trace data along with an appropriate number + of indentation spaces. + + + + The generic data included in the returned string includes a + timestamp (number of microseconds since the + first call to thread_indent() by the thread), + a process name, and the thread ID. This allows you to + identify what functions were called, who called them, and the + duration of each function call. + + + + If call entries and exits immediately precede each other, it is easy + to match them. However, in most cases, after a first function call + entry is made several other call entries and exits may be made + before the first call exits. The indentation counter helps you match + an entry with its corresponding exit by indenting the next function + call if it is not the exit of the previous one. + + + + Consider the following example on the use of + thread_indent(): + + + thread_indent.stp + + probe kernel.function("*@net/socket.c") + { + printf ("%s -> %s\n", thread_indent(1), probefunc()) + } + probe kernel.function("*@net/socket.c").return + { + printf ("%s <- %s\n", thread_indent(-1), probefunc()) + } + + + + + prints out the + thread_indent() and probe functions at each event + in the following format: + + + 0 ftp(7223): -> sys_socketcall + 1159 ftp(7223): -> sys_socket + 2173 ftp(7223): -> __sock_create + 2286 ftp(7223): -> sock_alloc_inode + 2737 ftp(7223): <- sock_alloc_inode + 3349 ftp(7223): -> sock_alloc + 3389 ftp(7223): <- sock_alloc + 3417 ftp(7223): <- __sock_create + 4117 ftp(7223): -> sock_create + 4160 ftp(7223): <- sock_create + 4301 ftp(7223): -> sock_map_fd + 4644 ftp(7223): -> sock_map_file + 4699 ftp(7223): <- sock_map_file + 4715 ftp(7223): <- sock_map_fd + 4732 ftp(7223): <- sys_socket + 4775 ftp(7223): <- sys_socketcall + + + This sample output contains the following information: + + + The time (in microseconds) since the initial thread_ident() call for the thread (included in the string from thread_ident()). + + The process name (and its corresponding ID) that made the function call (included in the string from thread_ident()). + + An arrow signifying whether the call was an entry (<-) or an exit (->); the indentations help you match specific function call entries with their corresponding exits. + + The name of the function called by the process. + + + remember to add a reference later to "tapsets" from here, to clarify + that thread_indent is defined in tapsets as a special function of sorts + + + + + + name + + +local variables +name + + + +variables (local) +name + + + +name +local variables + + + Identifies the name of a specific system call. This variable can + only be used in probes that use the event + syscall.system_call. + + + + + + target() + + + + functions + handler functions + target() + + + + handler functions + Handlers + target() + + + + target() + Handlers + handler functions + + + Used in conjunction with stap + script -x process + ID or stap + script -c + command. If you want to specify + a script to take an argument of a process ID or command, use + target() as the variable in the script to refer + to it. For example: + + + + targetexample.stp + + probe syscall.* { + if (pid() == target()) + printf("%s/n", name) + } + + + + + When is run with the argument + -x process ID, it + watches all system calls (as specified by the event + syscall.*) and prints out the name of all system + calls made by the specified process. + + + + This has the same effect as specifying if (pid() == + process ID) each time you wish + to target a specific process. However, using + target() makes it easier for you to re-use the + script, giving you the ability to simply pass a process ID as an + argument each time you wish to run the script (e.g. stap + targetexample.stp -x process ID). + + + + + + + + + + For more information about supported SystemTap functions, refer to + man stapfuncs. + + + will need a complete listing of supported handler functions? also, SystemTap function descriptions seem ambiguous, please advise. + + +
-
diff --git a/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-disktop.xml b/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-disktop.xml index 42f1986b..8a786d82 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-disktop.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-disktop.xml @@ -107,7 +107,24 @@ The time and date in the output of is returned by the functions ctime() and gettimeofday_s(). ctime() derives calendar time in terms of seconds passed since the Unix epoch (January 1, 1970). gettimeofday_s() counts the actual number of seconds since Unix epoch, which gives a fairly accurate human-readable timestamp for the output. - + + + local variables + sample usage + $return + + + + variables (local) + sample usage + $return + + + + $return + sample usage + local variables + In this script, the $return is a local variable that stores the actual number of bytes each process reads or writes from the virtual file system. diff --git a/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-iotime.xml b/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-iotime.xml index 7a1633aa..4d7d6b17 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-iotime.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-iotime.xml @@ -52,6 +52,26 @@ of microseconds it takes for any reads or writes to finish and tracks the amount of data (in bytes) read from or written to the file. + + + + local variables + sample usage + $count + + + + variables (local) + sample usage + $count + + + + $count + sample usage + local variables + + also uses the local variable $count to track the @@ -70,8 +90,10 @@ [...] 825946 3364 (NetworkManager) access /sys/class/net/eth0/carrier read: 8190 write: 0 825955 3364 (NetworkManager) iotime /sys/class/net/eth0/carrier time: 9 +[...] 117061 2460 (pcscd) access /dev/bus/usb/003/001 read: 43 write: 0 117065 2460 (pcscd) iotime /dev/bus/usb/003/001 time: 7 +[...] 3973737 2886 (sendmail) access /proc/loadavg read: 4096 write: 0 3973744 2886 (sendmail) iotime /proc/loadavg time: 11 [...] diff --git a/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-traceio.xml b/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-traceio.xml index ab260d63..1af1475d 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-traceio.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-traceio.xml @@ -55,7 +55,24 @@ executables. This information is tracked and printed out in 1-second intervals, and in descending order. + + + local variables + sample usage + $return + + + variables (local) + sample usage + $return + + + + $return + sample usage + local variables + Note that also uses the local variable $return, which is also used by from . -- cgit From cffd1e12179857f6fc50d848c7ecc35742aca75e Mon Sep 17 00:00:00 2001 From: William Cohen Date: Mon, 15 Dec 2008 14:29:30 -0500 Subject: Minor edits and format corrections. --- doc/SystemTap_Beginners_Guide/en-US/Scripts.xml | 138 ++++++++++----------- .../en-US/Understanding_How_SystemTap_Works.xml | 2 +- 2 files changed, 70 insertions(+), 70 deletions(-) (limited to 'doc') diff --git a/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml b/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml index fe2e69f4..bb71625e 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml @@ -129,7 +129,7 @@ SystemTap scripts use the file extension .stp, and - are conatains probes written in the following format: + contains probes written in the following format: @@ -555,21 +555,21 @@ probe timer.s(4) Consider the following sample script: - helloworld.stp - - probe begin - { - printf ("hello world\n") - exit () - } - - +helloworld.stp + +probe begin +{ + printf ("hello world\n") + exit () +} + + In , the event begin (i.e. the start of the session) triggers the handler enclosed in { }, which simply prints hello - world, then exits. + world followed by a new-line, then exits. @@ -666,15 +666,15 @@ probe timer.s(4) To illustrate this, consider the following probe example: - - variables-in-printf-statements.stp - - probe syscall.open - { - printf ("%s(%d) open\n", execname(), pid()) - } - - + +variables-in-printf-statements.stp + +probe syscall.open +{ + printf ("%s(%d) open\n", execname(), pid()) +} + + instructs SystemTap to probe all entries to @@ -688,16 +688,16 @@ probe timer.s(4) to "argument1", "format specifier2" is to "argument2", or is this clear enough? - - vmware-guestd(2206) open - hald(2360) open - hald(2360) open - hald(2360) open - df(3433) open - df(3433) open - df(3433) open - hald(2360) open - + +vmware-guestd(2206) open +hald(2360) open +hald(2360) open +hald(2360) open +df(3433) open +df(3433) open +df(3433) open +hald(2360) open + SystemTap Functions @@ -945,42 +945,42 @@ probe timer.s(4) thread_indent(): - thread_indent.stp - - probe kernel.function("*@net/socket.c") - { - printf ("%s -> %s\n", thread_indent(1), probefunc()) - } - probe kernel.function("*@net/socket.c").return - { - printf ("%s <- %s\n", thread_indent(-1), probefunc()) - } - - +thread_indent.stp + +probe kernel.function("*@net/socket.c") +{ + printf ("%s -> %s\n", thread_indent(1), probefunc()) +} +probe kernel.function("*@net/socket.c").return +{ + printf ("%s <- %s\n", thread_indent(-1), probefunc()) +} + + prints out the thread_indent() and probe functions at each event in the following format: - - 0 ftp(7223): -> sys_socketcall - 1159 ftp(7223): -> sys_socket - 2173 ftp(7223): -> __sock_create - 2286 ftp(7223): -> sock_alloc_inode - 2737 ftp(7223): <- sock_alloc_inode - 3349 ftp(7223): -> sock_alloc - 3389 ftp(7223): <- sock_alloc - 3417 ftp(7223): <- __sock_create - 4117 ftp(7223): -> sock_create - 4160 ftp(7223): <- sock_create - 4301 ftp(7223): -> sock_map_fd - 4644 ftp(7223): -> sock_map_file - 4699 ftp(7223): <- sock_map_file - 4715 ftp(7223): <- sock_map_fd - 4732 ftp(7223): <- sys_socket - 4775 ftp(7223): <- sys_socketcall - + +0 ftp(7223): -> sys_socketcall +1159 ftp(7223): -> sys_socket +2173 ftp(7223): -> __sock_create +2286 ftp(7223): -> sock_alloc_inode +2737 ftp(7223): <- sock_alloc_inode +3349 ftp(7223): -> sock_alloc +3389 ftp(7223): <- sock_alloc +3417 ftp(7223): <- __sock_create +4117 ftp(7223): -> sock_create +4160 ftp(7223): <- sock_create +4301 ftp(7223): -> sock_map_fd +4644 ftp(7223): -> sock_map_file +4699 ftp(7223): <- sock_map_file +4715 ftp(7223): <- sock_map_fd +4732 ftp(7223): <- sys_socket +4775 ftp(7223): <- sys_socketcall + This sample output contains the following information: @@ -1073,15 +1073,15 @@ probe timer.s(4) to it. For example: - - targetexample.stp - - probe syscall.* { - if (pid() == target()) - printf("%s/n", name) - } - - + +targetexample.stp + +probe syscall.* { + if (pid() == target()) + printf("%s/n", name) +} + + When is run with the argument diff --git a/doc/SystemTap_Beginners_Guide/en-US/Understanding_How_SystemTap_Works.xml b/doc/SystemTap_Beginners_Guide/en-US/Understanding_How_SystemTap_Works.xml index 4e61e247..d9fe6ab4 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Understanding_How_SystemTap_Works.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Understanding_How_SystemTap_Works.xml @@ -53,7 +53,7 @@ expiration, session termination, etc. A handler is a series of script language statements that specify the work to be done whenever the event occurs. This work normally includes extracting data from the event context, - storing them into internal variables, or printing results. + storing them into internal variables, and printing results.
-- cgit From 1179271f9a422edf543178d2d02d2bf38334e697 Mon Sep 17 00:00:00 2001 From: William Cohen Date: Mon, 15 Dec 2008 14:34:14 -0500 Subject: Clarify optional else clause. --- doc/SystemTap_Beginners_Guide/en-US/ScriptConstructs.xml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/SystemTap_Beginners_Guide/en-US/ScriptConstructs.xml b/doc/SystemTap_Beginners_Guide/en-US/ScriptConstructs.xml index 2550efce..89334eff 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/ScriptConstructs.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/ScriptConstructs.xml @@ -177,7 +177,8 @@ The statement1 is executed if the condition expression is non-zero. The statement2 is executed if the condition -expression is zero. The else is optional. Both +expression is zero. The else clause +(else statement2)is optional. Both statement1 and statement2 can be statement blocks. -- cgit From 16da491f985baaa0bfbdc9cd0098d508534bf75b Mon Sep 17 00:00:00 2001 From: William Cohen Date: Mon, 15 Dec 2008 14:52:52 -0500 Subject: Minor edits in associative array sections. --- doc/SystemTap_Beginners_Guide/en-US/Array-Operations.xml | 8 ++++---- doc/SystemTap_Beginners_Guide/en-US/Arrays.xml | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) (limited to 'doc') diff --git a/doc/SystemTap_Beginners_Guide/en-US/Array-Operations.xml b/doc/SystemTap_Beginners_Guide/en-US/Array-Operations.xml index bf496321..00a8673c 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Array-Operations.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Array-Operations.xml @@ -505,7 +505,7 @@ probe timer.s(3) } -This foreach statement instructs the script to process the elements in the array reads in descending order (of associated value). The limit 10 option instructs the script to only process the first ten elements in the array (i.e. the first 10, starting with the highest value). +This foreach statement instructs the script to process the elements in the array reads in descending order (of associated value). The limit 10 option instructs the foreach to only process the first ten iterations (i.e. print the first 10, starting with the highest value).
@@ -665,7 +665,7 @@ probe vfs.read probe timer.s(3) { printf("=======\n") - foreach (count in reads+) + foreach (count in reads-) printf("%s : %d \n", count, reads[count]) delete reads } @@ -673,7 +673,7 @@ probe timer.s(3) probe end { printf("TOTALS\n") - foreach (total in totalreads+) + foreach (total in totalreads-) printf("%s : %d \n", total, totalreads[total]) } @@ -788,7 +788,7 @@ probe timer.s(3) -if([index_expression] in array_name) +if([index_expression] in array_name) statement To illustrate this, consider the following example: diff --git a/doc/SystemTap_Beginners_Guide/en-US/Arrays.xml b/doc/SystemTap_Beginners_Guide/en-US/Arrays.xml index ac320fcd..3d3dec01 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Arrays.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Arrays.xml @@ -161,7 +161,7 @@ foo["harry"] = 25 -You can specify up to 5 index expressons in an array statement, each one delimited by a comma (,). This is useful if you wish to have a key that contains multiple pieces of information. The following line from uses 5 elements for the key: process ID, executable name, user ID, parent ID, and string "W". It associates the value of devname with that key. +You can specify up to 5 index expressons in an array statement, each one delimited by a comma (,). This is useful if you wish to have a key that contains multiple pieces of information. The following line from uses 5 elements for the key: process ID, executable name, user ID, parent process ID, and string "W". It associates the value of devname with that key. device[pid(),execname(),uid(),ppid(),"W"] = devname -- cgit From b3234491c1bf5e845a16f33f6f2c4dffd2bf6a77 Mon Sep 17 00:00:00 2001 From: William Cohen Date: Mon, 15 Dec 2008 16:14:05 -0500 Subject: Minor editing for example scripts. --- .../en-US/Useful_Scripts-inodewatch.xml | 11 +++++++---- .../en-US/Useful_Scripts-sockettrace.xml | 2 +- .../en-US/Useful_Scripts-traceio2.xml | 2 +- 3 files changed, 9 insertions(+), 6 deletions(-) (limited to 'doc') diff --git a/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-inodewatch.xml b/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-inodewatch.xml index 098524ae..47cc4e16 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-inodewatch.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-inodewatch.xml @@ -59,7 +59,8 @@ no script in examples need to add references to sources/man pages that explain how "dev_nr = $file->f_dentry->d_inode->i_sb->s_dev" and "($1 << 20 | $2)". - takes the following information about the file as an argument: + takes the following information about the +file as arguments on the command line: script examples file device number (integer format) @@ -81,7 +82,9 @@ no script in examples - The file's device number, in integer format. When this is passed to the script as the first argument, be sure to replace any 0 with a space. + The file's major device number. + + The file's minor device number. The file's inode number. @@ -121,9 +124,9 @@ no script in examples examples of SystemTap scripts -805 is the device number, while 1078319 is the inode number. To start monitoring /etc/crontab, run stap inodewatch.stp 8 5 1078319. +805 is the base-16 (hexadecimal) device number. The lower two digits are the minor device number and the upper digits are the major number. 1078319 is the inode number. To start monitoring /etc/crontab, run stap inodewatch.stp 0x8 0x05 1078319 (The 0x prefixes indicate base-16 values. -The output of this command contains the name and ID of any process performing a read/write, the function it is performing (i.e. vfs_read or vfs_write), the device number (in hex format), and the inode number. contains the output of stap inodewatch.stp 8 5 1078319 (when cat /etc/crontab is executed while the script is running) : +The output of this command contains the name and ID of any process performing a read/write, the function it is performing (i.e. vfs_read or vfs_write), the device number (in hex format), and the inode number. contains the output of stap inodewatch.stp 0x8 0x05 1078319 (when cat /etc/crontab is executed while the script is running) : diff --git a/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-sockettrace.xml b/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-sockettrace.xml index 9a9e1c55..6e913b48 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-sockettrace.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-sockettrace.xml @@ -51,7 +51,7 @@ socket-trace.stp - + diff --git a/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-traceio2.xml b/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-traceio2.xml index 4fc7ecc2..7451de98 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-traceio2.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-traceio2.xml @@ -50,7 +50,7 @@ - traceio2-simple.stp + traceio2.stp -- cgit From b1a80a41d336daa1501f56f73558806f15231f3c Mon Sep 17 00:00:00 2001 From: William Cohen Date: Mon, 15 Dec 2008 16:28:41 -0500 Subject: Minor edits error chapter. --- doc/SystemTap_Beginners_Guide/en-US/Errors.xml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/SystemTap_Beginners_Guide/en-US/Errors.xml b/doc/SystemTap_Beginners_Guide/en-US/Errors.xml index 910ff510..62e89580 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Errors.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Errors.xml @@ -101,7 +101,7 @@ replicate? - The following invalid SystemTap script is missing the its probe + The following invalid SystemTap script is missing its probe handlers: @@ -473,8 +473,9 @@ probe syscall.open foo refers to. This usually means that SystemTap could not find a match for foo in the - tapset library. The N refers to the column - the error occurred in. + tapset library. The N refers to the + line and column of + the error. how to explain N in previous? "The divergence from the “tree” of probe point namespace is at position N (starting with zero at left)." (from tutorial) -- cgit From 70be2c5b7a1ae10d23bb092a04031a119136aa47 Mon Sep 17 00:00:00 2001 From: ddomingo Date: Tue, 16 Dec 2008 12:06:35 +1000 Subject: corrected index entries as per wcohen --- doc/SystemTap_Beginners_Guide/en-US/Scripts.xml | 100 ++++++++++++------------ 1 file changed, 50 insertions(+), 50 deletions(-) (limited to 'doc') diff --git a/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml b/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml index bb71625e..88aa42ab 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml @@ -581,7 +581,7 @@ probe begin exit() - Handlers + functions SystemTap scripts continue to run until the @@ -732,20 +732,20 @@ hald(2360) open functions - handler functions - tid() + tid() + - handler functions - Handlers - tid() + functions + tid() + tid() - Handlers - handler functions + functions + The ID of the current thread. @@ -757,20 +757,20 @@ hald(2360) open functions - handler functions - uid() + + uid() - + uid() - Handlers - handler functions + functions + The ID of the current user. @@ -781,20 +781,20 @@ hald(2360) open functions - handler functions - cpu() + + cpu() - + cpu() - Handlers - handler functions + functions + The current CPU number. @@ -805,20 +805,20 @@ hald(2360) open functions - handler functions - gettimeofday_s() + + gettimeofday_s() - + gettimeofday_s() - Handlers - handler functions + functions + The number of seconds since UNIX epoch (January 1, 1970). @@ -830,20 +830,20 @@ hald(2360) open functions - handler functions - ctime() + + ctime() - + ctime() - Handlers - handler functions + functions + Convert number of seconds since UNIX epoch to date. @@ -865,20 +865,20 @@ hald(2360) open functions - handler functions - pp() + + pp() - + pp() - Handlers - handler functions + functions + A string describing the probe point currently being handled. @@ -897,20 +897,20 @@ hald(2360) open functions - handler functions - thread_indent() + + thread_indent() - + thread_indent() - Handlers - handler functions + functions + This particular function is quite useful, providing you with a way @@ -1047,20 +1047,20 @@ probe kernel.function("*@net/socket.c").return functions - handler functions - target() + + target() - + target() - Handlers - handler functions + functions + Used in conjunction with stap -- cgit From 5bfd7a3769ba6dcfc9240357ad97f5243da37333 Mon Sep 17 00:00:00 2001 From: William Cohen Date: Mon, 22 Dec 2008 13:26:10 -0500 Subject: Add generations of tapset reference manual material. --- doc/ChangeLog | 6 + doc/Makefile.am | 1 + doc/Makefile.in | 233 ++++++++++++++++++++++++----- doc/SystemTap_Tapset_Reference/Makefile.am | 25 ++-- doc/SystemTap_Tapset_Reference/Makefile.in | 102 +++++-------- 5 files changed, 258 insertions(+), 109 deletions(-) (limited to 'doc') diff --git a/doc/ChangeLog b/doc/ChangeLog index 9f992132..9cd46fe0 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,9 @@ +2008-12-21 Will Cohen + + * Makefile.am: Add generations of tapset reference manual material. + * SystemTap_Tapset_Reference/Makefile.am: Install tapset reference man. + * Makfile.am, SystemTap_Tapset_Reference/Makefile.in: Regenerated. + 2008-11-26 Will Cohen * SystemTap_Tapset_Reference/tapsets.tmpl: Add scsi. diff --git a/doc/Makefile.am b/doc/Makefile.am index fb228897..55291f7f 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -3,6 +3,7 @@ PDF_FILES = tutorial.pdf langref.pdf DOC_INSTALL_DIR = $(DESTDIR)$(datadir)/doc/systemtap +SUBDIRS = SystemTap_Tapset_Reference if BUILD_DOCS all-local: $(PDF_FILES) diff --git a/doc/Makefile.in b/doc/Makefile.in index c003c742..e3d8f852 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -42,6 +42,18 @@ CONFIG_HEADER = $(top_builddir)/config.h CONFIG_CLEAN_FILES = SOURCES = DIST_SOURCES = +RECURSIVE_TARGETS = all-recursive check-recursive dvi-recursive \ + html-recursive info-recursive install-data-recursive \ + install-dvi-recursive install-exec-recursive \ + install-html-recursive install-info-recursive \ + install-pdf-recursive install-ps-recursive install-recursive \ + installcheck-recursive installdirs-recursive pdf-recursive \ + ps-recursive uninstall-recursive +RECURSIVE_CLEAN_TARGETS = mostlyclean-recursive clean-recursive \ + distclean-recursive maintainer-clean-recursive +ETAGS = etags +CTAGS = ctags +DIST_SUBDIRS = $(SUBDIRS) DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) ACLOCAL = @ACLOCAL@ AMTAR = @AMTAR@ @@ -150,8 +162,9 @@ top_builddir = @top_builddir@ top_srcdir = @top_srcdir@ PDF_FILES = tutorial.pdf langref.pdf DOC_INSTALL_DIR = $(DESTDIR)$(datadir)/doc/systemtap +SUBDIRS = SystemTap_Tapset_Reference SUFFIXES = ps pdf dvi ps tex -all: all-am +all: all-recursive .SUFFIXES: .SUFFIXES: ps pdf dvi ps tex .dvi .pdf .ps .tex @@ -184,12 +197,136 @@ $(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh $(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +# This directory's subdirectories are mostly independent; you can cd +# into them and run `make' without going through this Makefile. +# To change the values of `make' variables: instead of editing Makefiles, +# (1) if the variable is set in `config.status', edit `config.status' +# (which will cause the Makefiles to be regenerated when you run `make'); +# (2) otherwise, pass the desired values on the `make' command line. +$(RECURSIVE_TARGETS): + @failcom='exit 1'; \ + for f in x $$MAKEFLAGS; do \ + case $$f in \ + *=* | --[!k]*);; \ + *k*) failcom='fail=yes';; \ + esac; \ + done; \ + dot_seen=no; \ + target=`echo $@ | sed s/-recursive//`; \ + list='$(SUBDIRS)'; for subdir in $$list; do \ + echo "Making $$target in $$subdir"; \ + if test "$$subdir" = "."; then \ + dot_seen=yes; \ + local_target="$$target-am"; \ + else \ + local_target="$$target"; \ + fi; \ + (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) $$local_target) \ + || eval $$failcom; \ + done; \ + if test "$$dot_seen" = "no"; then \ + $(MAKE) $(AM_MAKEFLAGS) "$$target-am" || exit 1; \ + fi; test -z "$$fail" + +$(RECURSIVE_CLEAN_TARGETS): + @failcom='exit 1'; \ + for f in x $$MAKEFLAGS; do \ + case $$f in \ + *=* | --[!k]*);; \ + *k*) failcom='fail=yes';; \ + esac; \ + done; \ + dot_seen=no; \ + case "$@" in \ + distclean-* | maintainer-clean-*) list='$(DIST_SUBDIRS)' ;; \ + *) list='$(SUBDIRS)' ;; \ + esac; \ + rev=''; for subdir in $$list; do \ + if test "$$subdir" = "."; then :; else \ + rev="$$subdir $$rev"; \ + fi; \ + done; \ + rev="$$rev ."; \ + target=`echo $@ | sed s/-recursive//`; \ + for subdir in $$rev; do \ + echo "Making $$target in $$subdir"; \ + if test "$$subdir" = "."; then \ + local_target="$$target-am"; \ + else \ + local_target="$$target"; \ + fi; \ + (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) $$local_target) \ + || eval $$failcom; \ + done && test -z "$$fail" +tags-recursive: + list='$(SUBDIRS)'; for subdir in $$list; do \ + test "$$subdir" = . || (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) tags); \ + done +ctags-recursive: + list='$(SUBDIRS)'; for subdir in $$list; do \ + test "$$subdir" = . || (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) ctags); \ + done + +ID: $(HEADERS) $(SOURCES) $(LISP) $(TAGS_FILES) + list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ + unique=`for i in $$list; do \ + if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ + done | \ + $(AWK) '{ files[$$0] = 1; nonemtpy = 1; } \ + END { if (nonempty) { for (i in files) print i; }; }'`; \ + mkid -fID $$unique tags: TAGS -TAGS: +TAGS: tags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ + $(TAGS_FILES) $(LISP) + tags=; \ + here=`pwd`; \ + if ($(ETAGS) --etags-include --version) >/dev/null 2>&1; then \ + include_option=--etags-include; \ + empty_fix=.; \ + else \ + include_option=--include; \ + empty_fix=; \ + fi; \ + list='$(SUBDIRS)'; for subdir in $$list; do \ + if test "$$subdir" = .; then :; else \ + test ! -f $$subdir/TAGS || \ + tags="$$tags $$include_option=$$here/$$subdir/TAGS"; \ + fi; \ + done; \ + list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ + unique=`for i in $$list; do \ + if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ + done | \ + $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ + END { if (nonempty) { for (i in files) print i; }; }'`; \ + if test -z "$(ETAGS_ARGS)$$tags$$unique"; then :; else \ + test -n "$$unique" || unique=$$empty_fix; \ + $(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \ + $$tags $$unique; \ + fi ctags: CTAGS -CTAGS: - +CTAGS: ctags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ + $(TAGS_FILES) $(LISP) + tags=; \ + list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ + unique=`for i in $$list; do \ + if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ + done | \ + $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ + END { if (nonempty) { for (i in files) print i; }; }'`; \ + test -z "$(CTAGS_ARGS)$$tags$$unique" \ + || $(CTAGS) $(CTAGSFLAGS) $(AM_CTAGSFLAGS) $(CTAGS_ARGS) \ + $$tags $$unique + +GTAGS: + here=`$(am__cd) $(top_builddir) && pwd` \ + && cd $(top_srcdir) \ + && gtags -i $(GTAGS_ARGS) $$here + +distclean-tags: + -rm -f TAGS ID GTAGS GRTAGS GSYMS GPATH tags distdir: $(DISTFILES) @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ @@ -217,20 +354,38 @@ distdir: $(DISTFILES) || exit 1; \ fi; \ done + list='$(DIST_SUBDIRS)'; for subdir in $$list; do \ + if test "$$subdir" = .; then :; else \ + test -d "$(distdir)/$$subdir" \ + || $(MKDIR_P) "$(distdir)/$$subdir" \ + || exit 1; \ + distdir=`$(am__cd) $(distdir) && pwd`; \ + top_distdir=`$(am__cd) $(top_distdir) && pwd`; \ + (cd $$subdir && \ + $(MAKE) $(AM_MAKEFLAGS) \ + top_distdir="$$top_distdir" \ + distdir="$$distdir/$$subdir" \ + am__remove_distdir=: \ + am__skip_length_check=: \ + distdir) \ + || exit 1; \ + fi; \ + done check-am: all-am -check: check-am +check: check-recursive @BUILD_DOCS_FALSE@all-local: all-am: Makefile all-local -installdirs: -install: install-am -install-exec: install-exec-am -install-data: install-data-am -uninstall: uninstall-am +installdirs: installdirs-recursive +installdirs-am: +install: install-recursive +install-exec: install-exec-recursive +install-data: install-data-recursive +uninstall: uninstall-recursive install-am: all-am @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am -installcheck: installcheck-am +installcheck: installcheck-recursive install-strip: $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ @@ -249,21 +404,21 @@ maintainer-clean-generic: @BUILD_DOCS_FALSE@uninstall-local: @BUILD_DOCS_FALSE@clean-local: @BUILD_DOCS_FALSE@install-data-hook: -clean: clean-am +clean: clean-recursive clean-am: clean-generic clean-local mostlyclean-am -distclean: distclean-am +distclean: distclean-recursive -rm -f Makefile -distclean-am: clean-am distclean-generic +distclean-am: clean-am distclean-generic distclean-tags -dvi: dvi-am +dvi: dvi-recursive dvi-am: -html: html-am +html: html-recursive -info: info-am +info: info-recursive info-am: @@ -271,52 +426,56 @@ install-data-am: @$(NORMAL_INSTALL) $(MAKE) $(AM_MAKEFLAGS) install-data-hook -install-dvi: install-dvi-am +install-dvi: install-dvi-recursive install-exec-am: -install-html: install-html-am +install-html: install-html-recursive -install-info: install-info-am +install-info: install-info-recursive install-man: -install-pdf: install-pdf-am +install-pdf: install-pdf-recursive -install-ps: install-ps-am +install-ps: install-ps-recursive installcheck-am: -maintainer-clean: maintainer-clean-am +maintainer-clean: maintainer-clean-recursive -rm -f Makefile maintainer-clean-am: distclean-am maintainer-clean-generic -mostlyclean: mostlyclean-am +mostlyclean: mostlyclean-recursive mostlyclean-am: mostlyclean-generic -pdf: pdf-am +pdf: pdf-recursive pdf-am: -ps: ps-am +ps: ps-recursive ps-am: uninstall-am: uninstall-local -.MAKE: install-am install-data-am install-strip - -.PHONY: all all-am all-local check check-am clean clean-generic \ - clean-local distclean distclean-generic distdir dvi dvi-am \ - html html-am info info-am install install-am install-data \ - install-data-am install-data-hook install-dvi install-dvi-am \ - install-exec install-exec-am install-html install-html-am \ - install-info install-info-am install-man install-pdf \ - install-pdf-am install-ps install-ps-am install-strip \ - installcheck installcheck-am installdirs maintainer-clean \ +.MAKE: $(RECURSIVE_CLEAN_TARGETS) $(RECURSIVE_TARGETS) install-am \ + install-data-am install-strip + +.PHONY: $(RECURSIVE_CLEAN_TARGETS) $(RECURSIVE_TARGETS) CTAGS GTAGS \ + all all-am all-local check check-am clean clean-generic \ + clean-local ctags ctags-recursive distclean distclean-generic \ + distclean-tags distdir dvi dvi-am html html-am info info-am \ + install install-am install-data install-data-am \ + install-data-hook install-dvi install-dvi-am install-exec \ + install-exec-am install-html install-html-am install-info \ + install-info-am install-man install-pdf install-pdf-am \ + install-ps install-ps-am install-strip installcheck \ + installcheck-am installdirs installdirs-am maintainer-clean \ maintainer-clean-generic mostlyclean mostlyclean-generic pdf \ - pdf-am ps ps-am uninstall uninstall-am uninstall-local + pdf-am ps ps-am tags tags-recursive uninstall uninstall-am \ + uninstall-local @BUILD_DOCS_TRUE@all-local: $(PDF_FILES) diff --git a/doc/SystemTap_Tapset_Reference/Makefile.am b/doc/SystemTap_Tapset_Reference/Makefile.am index c196e977..71f2cd55 100644 --- a/doc/SystemTap_Tapset_Reference/Makefile.am +++ b/doc/SystemTap_Tapset_Reference/Makefile.am @@ -1,6 +1,11 @@ # Makefile.am --- automake input file for systemtap tapset reference manual ## process this file with automake to produce Makefile.in +DOC_INSTALL_DIR = $(DESTDIR)$(datadir)/doc/systemtap +MAN_INSTALL_DIR = $(DESTDIR)$(mandir)/man5 +HTML_INSTALL_DIR = $(DESTDIR)$(datadir)/doc/systemtap/tapsets + + ### # The build process is as follows (targets): # (xmldocs) [by docproc] @@ -9,15 +14,12 @@ # +--> DIR=file (htmldocs) [by xmlto] # +--> man/ (mandocs) [by xmlto] -bin_PROGRAMS = docproc -docproc_SOURCES = docproc.c - -all: pdfdocs htmldocs mandocs - - +noinst_PROGRAMS = docproc SRCTREE=$(abs_top_srcdir)/ DOCPROC=$(abs_builddir)/docproc +if BUILD_DOCS +all: pdfdocs htmldocs mandocs xmldocs: docproc SRCTREE=$(SRCTREE) $(DOCPROC) doc $(abs_srcdir)/tapsets.tmpl > tapsets.xml @@ -32,6 +34,11 @@ mandocs: xmldocs #FIXME need to figure out where to install things appropriately #installmandocs: mandocs -# $(MKDIR_P) /usr/local/man/man5/ -# install Documentation/DocBook/man/*.5.gz /usr/local/man/man5/ - +install-data-hook: + $(MKDIR_P) $(DOC_INSTALL_DIR) + $(INSTALL_DATA) tapsets.pdf $(DOC_INSTALL_DIR) + $(MKDIR_P) $(MAN_INSTALL_DIR) + $(INSTALL_DATA) man5/* $(MAN_INSTALL_DIR) + $(MKDIR_P) $(HTML_INSTALL_DIR) + $(INSTALL_DATA) tapsets/* $(HTML_INSTALL_DIR) +endif diff --git a/doc/SystemTap_Tapset_Reference/Makefile.in b/doc/SystemTap_Tapset_Reference/Makefile.in index b61be1b7..1f01251d 100644 --- a/doc/SystemTap_Tapset_Reference/Makefile.in +++ b/doc/SystemTap_Tapset_Reference/Makefile.in @@ -16,14 +16,6 @@ # Makefile.am --- automake input file for systemtap tapset reference manual -### -# The build process is as follows (targets): -# (xmldocs) [by docproc] -# file.tmpl --> file.xml +--> file.ps (psdocs) [by xmlto] -# +--> file.pdf (pdfdocs) [by xmlto] -# +--> DIR=file (htmldocs) [by xmlto] -# +--> man/ (mandocs) [by xmlto] - VPATH = @srcdir@ pkgdatadir = $(datadir)/@PACKAGE@ pkglibdir = $(libdir)/@PACKAGE@ @@ -40,7 +32,7 @@ POST_INSTALL = : NORMAL_UNINSTALL = : PRE_UNINSTALL = : POST_UNINSTALL = : -bin_PROGRAMS = docproc$(EXEEXT) +noinst_PROGRAMS = docproc$(EXEEXT) subdir = doc/SystemTap_Tapset_Reference DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 @@ -50,11 +42,9 @@ am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ mkinstalldirs = $(install_sh) -d CONFIG_HEADER = $(top_builddir)/config.h CONFIG_CLEAN_FILES = -am__installdirs = "$(DESTDIR)$(bindir)" -binPROGRAMS_INSTALL = $(INSTALL_PROGRAM) -PROGRAMS = $(bin_PROGRAMS) -am_docproc_OBJECTS = docproc.$(OBJEXT) -docproc_OBJECTS = $(am_docproc_OBJECTS) +PROGRAMS = $(noinst_PROGRAMS) +docproc_SOURCES = docproc.c +docproc_OBJECTS = docproc.$(OBJEXT) docproc_LDADD = $(LDADD) DEFAULT_INCLUDES = -I.@am__isrc@ -I$(top_builddir) depcomp = $(SHELL) $(top_srcdir)/depcomp @@ -63,8 +53,8 @@ COMPILE = $(CC) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS) \ $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) CCLD = $(CC) LINK = $(CCLD) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@ -SOURCES = $(docproc_SOURCES) -DIST_SOURCES = $(docproc_SOURCES) +SOURCES = docproc.c +DIST_SOURCES = docproc.c ETAGS = etags CTAGS = ctags DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) @@ -173,7 +163,9 @@ sysconfdir = @sysconfdir@ target_alias = @target_alias@ top_builddir = @top_builddir@ top_srcdir = @top_srcdir@ -docproc_SOURCES = docproc.c +DOC_INSTALL_DIR = $(DESTDIR)$(datadir)/doc/systemtap +MAN_INSTALL_DIR = $(DESTDIR)$(mandir)/man5 +HTML_INSTALL_DIR = $(DESTDIR)$(datadir)/doc/systemtap/tapsets SRCTREE = $(abs_top_srcdir)/ DOCPROC = $(abs_builddir)/docproc all: all-am @@ -209,29 +201,9 @@ $(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh $(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh -install-binPROGRAMS: $(bin_PROGRAMS) - @$(NORMAL_INSTALL) - test -z "$(bindir)" || $(MKDIR_P) "$(DESTDIR)$(bindir)" - @list='$(bin_PROGRAMS)'; for p in $$list; do \ - p1=`echo $$p|sed 's/$(EXEEXT)$$//'`; \ - if test -f $$p \ - ; then \ - f=`echo "$$p1" | sed 's,^.*/,,;$(transform);s/$$/$(EXEEXT)/'`; \ - echo " $(INSTALL_PROGRAM_ENV) $(binPROGRAMS_INSTALL) '$$p' '$(DESTDIR)$(bindir)/$$f'"; \ - $(INSTALL_PROGRAM_ENV) $(binPROGRAMS_INSTALL) "$$p" "$(DESTDIR)$(bindir)/$$f" || exit 1; \ - else :; fi; \ - done -uninstall-binPROGRAMS: - @$(NORMAL_UNINSTALL) - @list='$(bin_PROGRAMS)'; for p in $$list; do \ - f=`echo "$$p" | sed 's,^.*/,,;s/$(EXEEXT)$$//;$(transform);s/$$/$(EXEEXT)/'`; \ - echo " rm -f '$(DESTDIR)$(bindir)/$$f'"; \ - rm -f "$(DESTDIR)$(bindir)/$$f"; \ - done - -clean-binPROGRAMS: - -test -z "$(bin_PROGRAMS)" || rm -f $(bin_PROGRAMS) +clean-noinstPROGRAMS: + -test -z "$(noinst_PROGRAMS)" || rm -f $(noinst_PROGRAMS) docproc$(EXEEXT): $(docproc_OBJECTS) $(docproc_DEPENDENCIES) @rm -f docproc$(EXEEXT) $(LINK) $(docproc_OBJECTS) $(docproc_LDADD) $(LIBS) @@ -335,9 +307,6 @@ check-am: all-am check: check-am all-am: Makefile $(PROGRAMS) installdirs: - for dir in "$(DESTDIR)$(bindir)"; do \ - test -z "$$dir" || $(MKDIR_P) "$$dir"; \ - done install: install-am install-exec: install-exec-am install-data: install-data-am @@ -362,9 +331,10 @@ distclean-generic: maintainer-clean-generic: @echo "This command is intended for maintainers to use" @echo "it deletes files that may require special tools to rebuild." +@BUILD_DOCS_FALSE@install-data-hook: clean: clean-am -clean-am: clean-binPROGRAMS clean-generic mostlyclean-am +clean-am: clean-generic clean-noinstPROGRAMS mostlyclean-am distclean: distclean-am -rm -rf ./$(DEPDIR) @@ -383,10 +353,12 @@ info: info-am info-am: install-data-am: + @$(NORMAL_INSTALL) + $(MAKE) $(AM_MAKEFLAGS) install-data-hook install-dvi: install-dvi-am -install-exec-am: install-binPROGRAMS +install-exec-am: install-html: install-html-am @@ -417,42 +389,46 @@ ps: ps-am ps-am: -uninstall-am: uninstall-binPROGRAMS +uninstall-am: -.MAKE: install-am install-strip +.MAKE: install-am install-data-am install-strip -.PHONY: CTAGS GTAGS all all-am check check-am clean clean-binPROGRAMS \ - clean-generic ctags distclean distclean-compile \ +.PHONY: CTAGS GTAGS all all-am check check-am clean clean-generic \ + clean-noinstPROGRAMS ctags distclean distclean-compile \ distclean-generic distclean-tags distdir dvi dvi-am html \ - html-am info info-am install install-am install-binPROGRAMS \ - install-data install-data-am install-dvi install-dvi-am \ + html-am info info-am install install-am install-data \ + install-data-am install-data-hook install-dvi install-dvi-am \ install-exec install-exec-am install-html install-html-am \ install-info install-info-am install-man install-pdf \ install-pdf-am install-ps install-ps-am install-strip \ installcheck installcheck-am installdirs maintainer-clean \ maintainer-clean-generic mostlyclean mostlyclean-compile \ mostlyclean-generic pdf pdf-am ps ps-am tags uninstall \ - uninstall-am uninstall-binPROGRAMS - + uninstall-am -all: pdfdocs htmldocs mandocs -xmldocs: docproc - SRCTREE=$(SRCTREE) $(DOCPROC) doc $(abs_srcdir)/tapsets.tmpl > tapsets.xml +@BUILD_DOCS_TRUE@all: pdfdocs htmldocs mandocs +@BUILD_DOCS_TRUE@xmldocs: docproc +@BUILD_DOCS_TRUE@ SRCTREE=$(SRCTREE) $(DOCPROC) doc $(abs_srcdir)/tapsets.tmpl > tapsets.xml -htmldocs: xmldocs - xmlto html -o tapsets tapsets.xml +@BUILD_DOCS_TRUE@htmldocs: xmldocs +@BUILD_DOCS_TRUE@ xmlto html -o tapsets tapsets.xml -pdfdocs: xmldocs - xmlto pdf tapsets.xml +@BUILD_DOCS_TRUE@pdfdocs: xmldocs +@BUILD_DOCS_TRUE@ xmlto pdf tapsets.xml -mandocs: xmldocs - xmlto man -o man5 tapsets.xml +@BUILD_DOCS_TRUE@mandocs: xmldocs +@BUILD_DOCS_TRUE@ xmlto man -o man5 tapsets.xml #FIXME need to figure out where to install things appropriately #installmandocs: mandocs -# $(MKDIR_P) /usr/local/man/man5/ -# install Documentation/DocBook/man/*.5.gz /usr/local/man/man5/ +@BUILD_DOCS_TRUE@install-data-hook: +@BUILD_DOCS_TRUE@ $(MKDIR_P) $(DOC_INSTALL_DIR) +@BUILD_DOCS_TRUE@ $(INSTALL_DATA) tapsets.pdf $(DOC_INSTALL_DIR) +@BUILD_DOCS_TRUE@ $(MKDIR_P) $(MAN_INSTALL_DIR) +@BUILD_DOCS_TRUE@ $(INSTALL_DATA) man5/* $(MAN_INSTALL_DIR) +@BUILD_DOCS_TRUE@ $(MKDIR_P) $(HTML_INSTALL_DIR) +@BUILD_DOCS_TRUE@ $(INSTALL_DATA) tapsets/* $(HTML_INSTALL_DIR) # Tell versions [3.59,3.63) of GNU make to not export all variables. # Otherwise a system limit (for SysV at least) may be exceeded. .NOEXPORT: -- cgit From 1cecb3c506475a0e0b0ee4180a91e1a9433d346b Mon Sep 17 00:00:00 2001 From: Dave Brolley Date: Wed, 24 Dec 2008 13:18:50 -0500 Subject: Systemtap compile server phase 2 (ssl) -- first cut. --- doc/ChangeLog | 5 +++++ doc/Makefile.in | 17 +++++++++-------- doc/SystemTap_Tapset_Reference/Makefile.in | 19 ++++++++++--------- 3 files changed, 24 insertions(+), 17 deletions(-) (limited to 'doc') diff --git a/doc/ChangeLog b/doc/ChangeLog index 9cd46fe0..21e92df7 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2008-12-24 Dave Brolley + + * Makefile.in: Regenerated. + * SystemTap_Tapset_Reference/Makefile.in: Regenerated. + 2008-12-21 Will Cohen * Makefile.am: Add generations of tapset reference manual material. diff --git a/doc/Makefile.in b/doc/Makefile.in index e3d8f852..8fbd15d3 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -1,8 +1,8 @@ -# Makefile.in generated by automake 1.10.1 from Makefile.am. +# Makefile.in generated by automake 1.10 from Makefile.am. # @configure_input@ # Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, -# 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc. +# 2003, 2004, 2005, 2006 Free Software Foundation, Inc. # This Makefile.in is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. @@ -273,8 +273,8 @@ ID: $(HEADERS) $(SOURCES) $(LISP) $(TAGS_FILES) unique=`for i in $$list; do \ if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ done | \ - $(AWK) '{ files[$$0] = 1; nonemtpy = 1; } \ - END { if (nonempty) { for (i in files) print i; }; }'`; \ + $(AWK) ' { files[$$0] = 1; } \ + END { for (i in files) print i; }'`; \ mkid -fID $$unique tags: TAGS @@ -299,8 +299,8 @@ TAGS: tags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ unique=`for i in $$list; do \ if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ done | \ - $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ - END { if (nonempty) { for (i in files) print i; }; }'`; \ + $(AWK) ' { files[$$0] = 1; } \ + END { for (i in files) print i; }'`; \ if test -z "$(ETAGS_ARGS)$$tags$$unique"; then :; else \ test -n "$$unique" || unique=$$empty_fix; \ $(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \ @@ -310,12 +310,13 @@ ctags: CTAGS CTAGS: ctags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ $(TAGS_FILES) $(LISP) tags=; \ + here=`pwd`; \ list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ unique=`for i in $$list; do \ if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ done | \ - $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ - END { if (nonempty) { for (i in files) print i; }; }'`; \ + $(AWK) ' { files[$$0] = 1; } \ + END { for (i in files) print i; }'`; \ test -z "$(CTAGS_ARGS)$$tags$$unique" \ || $(CTAGS) $(CTAGSFLAGS) $(AM_CTAGSFLAGS) $(CTAGS_ARGS) \ $$tags $$unique diff --git a/doc/SystemTap_Tapset_Reference/Makefile.in b/doc/SystemTap_Tapset_Reference/Makefile.in index 1f01251d..dfeb5938 100644 --- a/doc/SystemTap_Tapset_Reference/Makefile.in +++ b/doc/SystemTap_Tapset_Reference/Makefile.in @@ -1,8 +1,8 @@ -# Makefile.in generated by automake 1.10.1 from Makefile.am. +# Makefile.in generated by automake 1.10 from Makefile.am. # @configure_input@ # Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, -# 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc. +# 2003, 2004, 2005, 2006 Free Software Foundation, Inc. # This Makefile.in is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. @@ -46,7 +46,7 @@ PROGRAMS = $(noinst_PROGRAMS) docproc_SOURCES = docproc.c docproc_OBJECTS = docproc.$(OBJEXT) docproc_LDADD = $(LDADD) -DEFAULT_INCLUDES = -I.@am__isrc@ -I$(top_builddir) +DEFAULT_INCLUDES = -I. -I$(top_builddir)@am__isrc@ depcomp = $(SHELL) $(top_srcdir)/depcomp am__depfiles_maybe = depfiles COMPILE = $(CC) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS) \ @@ -235,8 +235,8 @@ ID: $(HEADERS) $(SOURCES) $(LISP) $(TAGS_FILES) unique=`for i in $$list; do \ if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ done | \ - $(AWK) '{ files[$$0] = 1; nonemtpy = 1; } \ - END { if (nonempty) { for (i in files) print i; }; }'`; \ + $(AWK) ' { files[$$0] = 1; } \ + END { for (i in files) print i; }'`; \ mkid -fID $$unique tags: TAGS @@ -248,8 +248,8 @@ TAGS: $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ unique=`for i in $$list; do \ if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ done | \ - $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ - END { if (nonempty) { for (i in files) print i; }; }'`; \ + $(AWK) ' { files[$$0] = 1; } \ + END { for (i in files) print i; }'`; \ if test -z "$(ETAGS_ARGS)$$tags$$unique"; then :; else \ test -n "$$unique" || unique=$$empty_fix; \ $(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \ @@ -259,12 +259,13 @@ ctags: CTAGS CTAGS: $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ $(TAGS_FILES) $(LISP) tags=; \ + here=`pwd`; \ list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ unique=`for i in $$list; do \ if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ done | \ - $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ - END { if (nonempty) { for (i in files) print i; }; }'`; \ + $(AWK) ' { files[$$0] = 1; } \ + END { for (i in files) print i; }'`; \ test -z "$(CTAGS_ARGS)$$tags$$unique" \ || $(CTAGS) $(CTAGSFLAGS) $(AM_CTAGSFLAGS) $(CTAGS_ARGS) \ $$tags $$unique -- cgit From 43498922cd6b61c530b0ed16299805053ebf7e42 Mon Sep 17 00:00:00 2001 From: Dave Brolley Date: Tue, 30 Dec 2008 12:15:24 -0500 Subject: COnfigure nss and nspr using PKG_CHECK_MODULES. --- doc/ChangeLog | 6 ++++++ doc/Makefile.in | 5 +++++ doc/SystemTap_Tapset_Reference/Makefile.in | 5 +++++ 3 files changed, 16 insertions(+) (limited to 'doc') diff --git a/doc/ChangeLog b/doc/ChangeLog index 21e92df7..c05a0a0f 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,9 @@ +2008-12-30 Dave Brolley + + PR9692 + * Makefile.in: Regenerated. + * SystemTap_Tapset_Reference/Makefile.in: Regenerated. + 2008-12-24 Dave Brolley * Makefile.in: Regenerated. diff --git a/doc/Makefile.in b/doc/Makefile.in index 8fbd15d3..4ab1ee2f 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -102,6 +102,7 @@ PACKAGE_TARNAME = @PACKAGE_TARNAME@ PACKAGE_VERSION = @PACKAGE_VERSION@ PATH_SEPARATOR = @PATH_SEPARATOR@ PIELDFLAGS = @PIELDFLAGS@ +PKG_CONFIG = @PKG_CONFIG@ PROCFLAGS = @PROCFLAGS@ RANLIB = @RANLIB@ SET_MAKE = @SET_MAKE@ @@ -144,6 +145,10 @@ localedir = @localedir@ localstatedir = @localstatedir@ mandir = @mandir@ mkdir_p = @mkdir_p@ +nspr_CFLAGS = @nspr_CFLAGS@ +nspr_LIBS = @nspr_LIBS@ +nss_CFLAGS = @nss_CFLAGS@ +nss_LIBS = @nss_LIBS@ oldincludedir = @oldincludedir@ pdfdir = @pdfdir@ prefix = @prefix@ diff --git a/doc/SystemTap_Tapset_Reference/Makefile.in b/doc/SystemTap_Tapset_Reference/Makefile.in index dfeb5938..839c6672 100644 --- a/doc/SystemTap_Tapset_Reference/Makefile.in +++ b/doc/SystemTap_Tapset_Reference/Makefile.in @@ -105,6 +105,7 @@ PACKAGE_TARNAME = @PACKAGE_TARNAME@ PACKAGE_VERSION = @PACKAGE_VERSION@ PATH_SEPARATOR = @PATH_SEPARATOR@ PIELDFLAGS = @PIELDFLAGS@ +PKG_CONFIG = @PKG_CONFIG@ PROCFLAGS = @PROCFLAGS@ RANLIB = @RANLIB@ SET_MAKE = @SET_MAKE@ @@ -147,6 +148,10 @@ localedir = @localedir@ localstatedir = @localstatedir@ mandir = @mandir@ mkdir_p = @mkdir_p@ +nspr_CFLAGS = @nspr_CFLAGS@ +nspr_LIBS = @nspr_LIBS@ +nss_CFLAGS = @nss_CFLAGS@ +nss_LIBS = @nss_LIBS@ oldincludedir = @oldincludedir@ pdfdir = @pdfdir@ prefix = @prefix@ -- cgit From e100f0744e77c5270dd8347f78bb97ee2aab878f Mon Sep 17 00:00:00 2001 From: "Frank Ch. Eigler" Date: Tue, 6 Jan 2009 12:40:16 -0500 Subject: build: don't needlessly rebuild tapset ref docs --- doc/ChangeLog | 6 ++++++ doc/SystemTap_Tapset_Reference/Makefile.am | 21 ++++++++++++++------- doc/SystemTap_Tapset_Reference/Makefile.in | 21 ++++++++++++++------- 3 files changed, 34 insertions(+), 14 deletions(-) (limited to 'doc') diff --git a/doc/ChangeLog b/doc/ChangeLog index c05a0a0f..056a4d04 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,9 @@ +2009-01-06 Frank Ch. Eigler + + * S_T_R/Makefile.am: Regenerate docs only as necessary, via + stamp-* files for html/man, and cmp for tapsets.xml. + * S_T_R/Makefile.in: Regenerated. + 2008-12-30 Dave Brolley PR9692 diff --git a/doc/SystemTap_Tapset_Reference/Makefile.am b/doc/SystemTap_Tapset_Reference/Makefile.am index 71f2cd55..609519e4 100644 --- a/doc/SystemTap_Tapset_Reference/Makefile.am +++ b/doc/SystemTap_Tapset_Reference/Makefile.am @@ -19,18 +19,25 @@ SRCTREE=$(abs_top_srcdir)/ DOCPROC=$(abs_builddir)/docproc if BUILD_DOCS -all: pdfdocs htmldocs mandocs -xmldocs: docproc - SRCTREE=$(SRCTREE) $(DOCPROC) doc $(abs_srcdir)/tapsets.tmpl > tapsets.xml - -htmldocs: xmldocs +all: tapsets.pdf stamp-htmldocs stamp-mandocs +tapsets.xml: docproc $(shell find $(SRCTREE) -name '*.stp') + SRCTREE=$(SRCTREE) $(DOCPROC) doc $(abs_srcdir)/tapsets.tmpl > tapsets.xml.new + if cmp tapsets.xml.new tapsets.xml >/dev/null ; then \ + echo tapsets.xml unchanged; \ + else \ + mv tapsets.xml.new tapsets.xml; \ + fi + +stamp-htmldocs: tapsets.xml xmlto html -o tapsets tapsets.xml + touch stamp-htmldocs -pdfdocs: xmldocs +tapsets.pdf: tapsets.xml xmlto pdf tapsets.xml -mandocs: xmldocs +stamp-mandocs: tapsets.xml xmlto man -o man5 tapsets.xml + touch stamp-mandocs #FIXME need to figure out where to install things appropriately #installmandocs: mandocs diff --git a/doc/SystemTap_Tapset_Reference/Makefile.in b/doc/SystemTap_Tapset_Reference/Makefile.in index 839c6672..b2fc56e0 100644 --- a/doc/SystemTap_Tapset_Reference/Makefile.in +++ b/doc/SystemTap_Tapset_Reference/Makefile.in @@ -413,18 +413,25 @@ uninstall-am: uninstall-am -@BUILD_DOCS_TRUE@all: pdfdocs htmldocs mandocs -@BUILD_DOCS_TRUE@xmldocs: docproc -@BUILD_DOCS_TRUE@ SRCTREE=$(SRCTREE) $(DOCPROC) doc $(abs_srcdir)/tapsets.tmpl > tapsets.xml - -@BUILD_DOCS_TRUE@htmldocs: xmldocs +@BUILD_DOCS_TRUE@all: tapsets.pdf stamp-htmldocs stamp-mandocs +@BUILD_DOCS_TRUE@tapsets.xml: docproc $(shell find $(SRCTREE) -name '*.stp') +@BUILD_DOCS_TRUE@ SRCTREE=$(SRCTREE) $(DOCPROC) doc $(abs_srcdir)/tapsets.tmpl > tapsets.xml.new +@BUILD_DOCS_TRUE@ if cmp tapsets.xml.new tapsets.xml >/dev/null ; then \ +@BUILD_DOCS_TRUE@ echo tapsets.xml unchanged; \ +@BUILD_DOCS_TRUE@ else \ +@BUILD_DOCS_TRUE@ mv tapsets.xml.new tapsets.xml; \ +@BUILD_DOCS_TRUE@ fi + +@BUILD_DOCS_TRUE@stamp-htmldocs: tapsets.xml @BUILD_DOCS_TRUE@ xmlto html -o tapsets tapsets.xml +@BUILD_DOCS_TRUE@ touch stamp-htmldocs -@BUILD_DOCS_TRUE@pdfdocs: xmldocs +@BUILD_DOCS_TRUE@tapsets.pdf: tapsets.xml @BUILD_DOCS_TRUE@ xmlto pdf tapsets.xml -@BUILD_DOCS_TRUE@mandocs: xmldocs +@BUILD_DOCS_TRUE@stamp-mandocs: tapsets.xml @BUILD_DOCS_TRUE@ xmlto man -o man5 tapsets.xml +@BUILD_DOCS_TRUE@ touch stamp-mandocs #FIXME need to figure out where to install things appropriately #installmandocs: mandocs -- cgit From 92aff3c7556ad0f968ff97d5755e4a6488eb80a8 Mon Sep 17 00:00:00 2001 From: Will Cohen Date: Wed, 7 Jan 2009 12:13:50 -0500 Subject: Check xmlto available and allow user to control generation of reference docs. --- doc/ChangeLog | 5 +++ doc/Makefile.in | 18 ++++---- doc/SystemTap_Tapset_Reference/Makefile.am | 2 +- doc/SystemTap_Tapset_Reference/Makefile.in | 68 +++++++++++++++--------------- 4 files changed, 49 insertions(+), 44 deletions(-) (limited to 'doc') diff --git a/doc/ChangeLog b/doc/ChangeLog index 056a4d04..29721280 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2009-01-07 William Cohen + + * S_T_R/Makefile.am: Use BUILD_REFDOCS. + * S_T_R/Makefile.in: Regenerated. + 2009-01-06 Frank Ch. Eigler * S_T_R/Makefile.am: Regenerate docs only as necessary, via diff --git a/doc/Makefile.in b/doc/Makefile.in index 4ab1ee2f..e7716e63 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -1,8 +1,8 @@ -# Makefile.in generated by automake 1.10 from Makefile.am. +# Makefile.in generated by automake 1.10.1 from Makefile.am. # @configure_input@ # Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, -# 2003, 2004, 2005, 2006 Free Software Foundation, Inc. +# 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc. # This Makefile.in is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. @@ -134,6 +134,7 @@ have_dvips = @have_dvips@ have_latex = @have_latex@ have_latex2html = @have_latex2html@ have_ps2pdf = @have_ps2pdf@ +have_xmlto = @have_xmlto@ host_alias = @host_alias@ htmldir = @htmldir@ includedir = @includedir@ @@ -278,8 +279,8 @@ ID: $(HEADERS) $(SOURCES) $(LISP) $(TAGS_FILES) unique=`for i in $$list; do \ if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ done | \ - $(AWK) ' { files[$$0] = 1; } \ - END { for (i in files) print i; }'`; \ + $(AWK) '{ files[$$0] = 1; nonemtpy = 1; } \ + END { if (nonempty) { for (i in files) print i; }; }'`; \ mkid -fID $$unique tags: TAGS @@ -304,8 +305,8 @@ TAGS: tags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ unique=`for i in $$list; do \ if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ done | \ - $(AWK) ' { files[$$0] = 1; } \ - END { for (i in files) print i; }'`; \ + $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ + END { if (nonempty) { for (i in files) print i; }; }'`; \ if test -z "$(ETAGS_ARGS)$$tags$$unique"; then :; else \ test -n "$$unique" || unique=$$empty_fix; \ $(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \ @@ -315,13 +316,12 @@ ctags: CTAGS CTAGS: ctags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ $(TAGS_FILES) $(LISP) tags=; \ - here=`pwd`; \ list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ unique=`for i in $$list; do \ if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ done | \ - $(AWK) ' { files[$$0] = 1; } \ - END { for (i in files) print i; }'`; \ + $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ + END { if (nonempty) { for (i in files) print i; }; }'`; \ test -z "$(CTAGS_ARGS)$$tags$$unique" \ || $(CTAGS) $(CTAGSFLAGS) $(AM_CTAGSFLAGS) $(CTAGS_ARGS) \ $$tags $$unique diff --git a/doc/SystemTap_Tapset_Reference/Makefile.am b/doc/SystemTap_Tapset_Reference/Makefile.am index 609519e4..9e7d2069 100644 --- a/doc/SystemTap_Tapset_Reference/Makefile.am +++ b/doc/SystemTap_Tapset_Reference/Makefile.am @@ -18,7 +18,7 @@ noinst_PROGRAMS = docproc SRCTREE=$(abs_top_srcdir)/ DOCPROC=$(abs_builddir)/docproc -if BUILD_DOCS +if BUILD_REFDOCS all: tapsets.pdf stamp-htmldocs stamp-mandocs tapsets.xml: docproc $(shell find $(SRCTREE) -name '*.stp') SRCTREE=$(SRCTREE) $(DOCPROC) doc $(abs_srcdir)/tapsets.tmpl > tapsets.xml.new diff --git a/doc/SystemTap_Tapset_Reference/Makefile.in b/doc/SystemTap_Tapset_Reference/Makefile.in index b2fc56e0..09fcf2dc 100644 --- a/doc/SystemTap_Tapset_Reference/Makefile.in +++ b/doc/SystemTap_Tapset_Reference/Makefile.in @@ -1,8 +1,8 @@ -# Makefile.in generated by automake 1.10 from Makefile.am. +# Makefile.in generated by automake 1.10.1 from Makefile.am. # @configure_input@ # Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, -# 2003, 2004, 2005, 2006 Free Software Foundation, Inc. +# 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc. # This Makefile.in is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. @@ -46,7 +46,7 @@ PROGRAMS = $(noinst_PROGRAMS) docproc_SOURCES = docproc.c docproc_OBJECTS = docproc.$(OBJEXT) docproc_LDADD = $(LDADD) -DEFAULT_INCLUDES = -I. -I$(top_builddir)@am__isrc@ +DEFAULT_INCLUDES = -I.@am__isrc@ -I$(top_builddir) depcomp = $(SHELL) $(top_srcdir)/depcomp am__depfiles_maybe = depfiles COMPILE = $(CC) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS) \ @@ -137,6 +137,7 @@ have_dvips = @have_dvips@ have_latex = @have_latex@ have_latex2html = @have_latex2html@ have_ps2pdf = @have_ps2pdf@ +have_xmlto = @have_xmlto@ host_alias = @host_alias@ htmldir = @htmldir@ includedir = @includedir@ @@ -240,8 +241,8 @@ ID: $(HEADERS) $(SOURCES) $(LISP) $(TAGS_FILES) unique=`for i in $$list; do \ if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ done | \ - $(AWK) ' { files[$$0] = 1; } \ - END { for (i in files) print i; }'`; \ + $(AWK) '{ files[$$0] = 1; nonemtpy = 1; } \ + END { if (nonempty) { for (i in files) print i; }; }'`; \ mkid -fID $$unique tags: TAGS @@ -253,8 +254,8 @@ TAGS: $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ unique=`for i in $$list; do \ if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ done | \ - $(AWK) ' { files[$$0] = 1; } \ - END { for (i in files) print i; }'`; \ + $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ + END { if (nonempty) { for (i in files) print i; }; }'`; \ if test -z "$(ETAGS_ARGS)$$tags$$unique"; then :; else \ test -n "$$unique" || unique=$$empty_fix; \ $(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \ @@ -264,13 +265,12 @@ ctags: CTAGS CTAGS: $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ $(TAGS_FILES) $(LISP) tags=; \ - here=`pwd`; \ list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ unique=`for i in $$list; do \ if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ done | \ - $(AWK) ' { files[$$0] = 1; } \ - END { for (i in files) print i; }'`; \ + $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ + END { if (nonempty) { for (i in files) print i; }; }'`; \ test -z "$(CTAGS_ARGS)$$tags$$unique" \ || $(CTAGS) $(CTAGSFLAGS) $(AM_CTAGSFLAGS) $(CTAGS_ARGS) \ $$tags $$unique @@ -337,7 +337,7 @@ distclean-generic: maintainer-clean-generic: @echo "This command is intended for maintainers to use" @echo "it deletes files that may require special tools to rebuild." -@BUILD_DOCS_FALSE@install-data-hook: +@BUILD_REFDOCS_FALSE@install-data-hook: clean: clean-am clean-am: clean-generic clean-noinstPROGRAMS mostlyclean-am @@ -413,35 +413,35 @@ uninstall-am: uninstall-am -@BUILD_DOCS_TRUE@all: tapsets.pdf stamp-htmldocs stamp-mandocs -@BUILD_DOCS_TRUE@tapsets.xml: docproc $(shell find $(SRCTREE) -name '*.stp') -@BUILD_DOCS_TRUE@ SRCTREE=$(SRCTREE) $(DOCPROC) doc $(abs_srcdir)/tapsets.tmpl > tapsets.xml.new -@BUILD_DOCS_TRUE@ if cmp tapsets.xml.new tapsets.xml >/dev/null ; then \ -@BUILD_DOCS_TRUE@ echo tapsets.xml unchanged; \ -@BUILD_DOCS_TRUE@ else \ -@BUILD_DOCS_TRUE@ mv tapsets.xml.new tapsets.xml; \ -@BUILD_DOCS_TRUE@ fi +@BUILD_REFDOCS_TRUE@all: tapsets.pdf stamp-htmldocs stamp-mandocs +@BUILD_REFDOCS_TRUE@tapsets.xml: docproc $(shell find $(SRCTREE) -name '*.stp') +@BUILD_REFDOCS_TRUE@ SRCTREE=$(SRCTREE) $(DOCPROC) doc $(abs_srcdir)/tapsets.tmpl > tapsets.xml.new +@BUILD_REFDOCS_TRUE@ if cmp tapsets.xml.new tapsets.xml >/dev/null ; then \ +@BUILD_REFDOCS_TRUE@ echo tapsets.xml unchanged; \ +@BUILD_REFDOCS_TRUE@ else \ +@BUILD_REFDOCS_TRUE@ mv tapsets.xml.new tapsets.xml; \ +@BUILD_REFDOCS_TRUE@ fi -@BUILD_DOCS_TRUE@stamp-htmldocs: tapsets.xml -@BUILD_DOCS_TRUE@ xmlto html -o tapsets tapsets.xml -@BUILD_DOCS_TRUE@ touch stamp-htmldocs +@BUILD_REFDOCS_TRUE@stamp-htmldocs: tapsets.xml +@BUILD_REFDOCS_TRUE@ xmlto html -o tapsets tapsets.xml +@BUILD_REFDOCS_TRUE@ touch stamp-htmldocs -@BUILD_DOCS_TRUE@tapsets.pdf: tapsets.xml -@BUILD_DOCS_TRUE@ xmlto pdf tapsets.xml +@BUILD_REFDOCS_TRUE@tapsets.pdf: tapsets.xml +@BUILD_REFDOCS_TRUE@ xmlto pdf tapsets.xml -@BUILD_DOCS_TRUE@stamp-mandocs: tapsets.xml -@BUILD_DOCS_TRUE@ xmlto man -o man5 tapsets.xml -@BUILD_DOCS_TRUE@ touch stamp-mandocs +@BUILD_REFDOCS_TRUE@stamp-mandocs: tapsets.xml +@BUILD_REFDOCS_TRUE@ xmlto man -o man5 tapsets.xml +@BUILD_REFDOCS_TRUE@ touch stamp-mandocs #FIXME need to figure out where to install things appropriately #installmandocs: mandocs -@BUILD_DOCS_TRUE@install-data-hook: -@BUILD_DOCS_TRUE@ $(MKDIR_P) $(DOC_INSTALL_DIR) -@BUILD_DOCS_TRUE@ $(INSTALL_DATA) tapsets.pdf $(DOC_INSTALL_DIR) -@BUILD_DOCS_TRUE@ $(MKDIR_P) $(MAN_INSTALL_DIR) -@BUILD_DOCS_TRUE@ $(INSTALL_DATA) man5/* $(MAN_INSTALL_DIR) -@BUILD_DOCS_TRUE@ $(MKDIR_P) $(HTML_INSTALL_DIR) -@BUILD_DOCS_TRUE@ $(INSTALL_DATA) tapsets/* $(HTML_INSTALL_DIR) +@BUILD_REFDOCS_TRUE@install-data-hook: +@BUILD_REFDOCS_TRUE@ $(MKDIR_P) $(DOC_INSTALL_DIR) +@BUILD_REFDOCS_TRUE@ $(INSTALL_DATA) tapsets.pdf $(DOC_INSTALL_DIR) +@BUILD_REFDOCS_TRUE@ $(MKDIR_P) $(MAN_INSTALL_DIR) +@BUILD_REFDOCS_TRUE@ $(INSTALL_DATA) man5/* $(MAN_INSTALL_DIR) +@BUILD_REFDOCS_TRUE@ $(MKDIR_P) $(HTML_INSTALL_DIR) +@BUILD_REFDOCS_TRUE@ $(INSTALL_DATA) tapsets/* $(HTML_INSTALL_DIR) # Tell versions [3.59,3.63) of GNU make to not export all variables. # Otherwise a system limit (for SysV at least) may be exceeded. .NOEXPORT: -- cgit From 71e8b62e3103d37865c2dfdfe2d8260f34031cb0 Mon Sep 17 00:00:00 2001 From: William Cohen Date: Mon, 12 Jan 2009 09:19:36 -0500 Subject: Correct author's name. --- doc/ChangeLog | 4 ++++ doc/SystemTap_Tapset_Reference/tapsets.tmpl | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/ChangeLog b/doc/ChangeLog index 29721280..33ff669b 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2009-01-12 William Cohen + + * S_T_R/tapsets.tmpl: Correct author's name. + 2009-01-07 William Cohen * S_T_R/Makefile.am: Use BUILD_REFDOCS. diff --git a/doc/SystemTap_Tapset_Reference/tapsets.tmpl b/doc/SystemTap_Tapset_Reference/tapsets.tmpl index 00dcd92f..ac06e87a 100644 --- a/doc/SystemTap_Tapset_Reference/tapsets.tmpl +++ b/doc/SystemTap_Tapset_Reference/tapsets.tmpl @@ -8,7 +8,7 @@ - Willliam + William Cohen
-- cgit From 3da34b09f2581093983ca29c2522a500c569a9ca Mon Sep 17 00:00:00 2001 From: William Cohen Date: Wed, 21 Jan 2009 17:08:34 -0500 Subject: Update copyright date and correct paragraph. --- doc/ChangeLog | 4 ++++ doc/SystemTap_Tapset_Reference/tapsets.tmpl | 11 +++++------ 2 files changed, 9 insertions(+), 6 deletions(-) (limited to 'doc') diff --git a/doc/ChangeLog b/doc/ChangeLog index 33ff669b..ef31a5ea 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2009-01-21 William Cohen + + * S_T_R/tapsets.tmpl: Update copyright date and correct paragraph. + 2009-01-12 William Cohen * S_T_R/tapsets.tmpl: Correct author's name. diff --git a/doc/SystemTap_Tapset_Reference/tapsets.tmpl b/doc/SystemTap_Tapset_Reference/tapsets.tmpl index ac06e87a..cbbc3b3a 100644 --- a/doc/SystemTap_Tapset_Reference/tapsets.tmpl +++ b/doc/SystemTap_Tapset_Reference/tapsets.tmpl @@ -19,7 +19,7 @@ - 2008 + 2008, 2009 Red Hat, Inc. @@ -92,11 +92,10 @@ - In some cases, tapsets do not have a return v -alue. This - simply means that the tapset does not extract anything from the kernel. -This is common among - asynchronous events such as timers, exit functions, and print functions. + In some cases, tapsets do not have a return + value. This simply means that the tapset does not extract anything from + the kernel. This is common among asynchronous events such as timers, + exit functions, and print functions.