tools: Document use of -I <path> in trace, argdist
authorShelbyFrances <ShelbyFrances@hushmail.com>
Wed, 8 Feb 2017 02:56:53 +0000 (05:56 +0300)
committerShelbyFrances <ShelbyFrances@hushmail.com>
Mon, 13 Feb 2017 19:48:39 +0000 (22:48 +0300)
tools/argdist_example.txt
tools/trace_example.txt

index 44cf922..963554f 100644 (file)
@@ -363,6 +363,7 @@ optional arguments:
                         below)
   -I header, --include header
                         additional header files to include in the BPF program
+                        as either full path, or relative to '/usr/include'
 
 Probe specifier syntax:
         {p,r,t,u}:{[library],category}:function(signature)[:type[,type...]:expr[,expr...][:filter]][#label]
index 6e56173..504030c 100644 (file)
@@ -2,8 +2,8 @@ Demonstrations of trace.
 
 
 trace probes functions you specify and displays trace messages if a particular
-condition is met. You can control the message format to display function 
-arguments and return values. 
+condition is met. You can control the message format to display function
+arguments and return values.
 
 For example, suppose you want to trace all commands being exec'd across the
 system:
@@ -174,8 +174,12 @@ PID    TID    COMM         FUNC             -
 777    785    automount    SyS_nanosleep    sleep for 500000000 ns
 ^C
 
+Remember to use the -I argument include the appropriate header file. We didn't
+need to do that here because `struct timespec` is used internally by the tool,
+so it always includes this header file.
 
-As a final example, let's trace open syscalls for a specific process. By 
+
+As a final example, let's trace open syscalls for a specific process. By
 default, tracing is system-wide, but the -p switch overrides this:
 
 # trace -p 2740 'do_sys_open "%s", arg2' -T
@@ -225,6 +229,7 @@ optional arguments:
   -U, --user-stack      output user stack trace
   -I header, --include header
                         additional header files to include in the BPF program
+                        as either full path, or relative to '/usr/include'
 
 EXAMPLES: