Improve documentation of the syscall extractor script

Signed-off-by: Yannick Brosseau <yannick.brosseau@gmail.com>
Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>

diff --git a/instrumentation/syscalls/README b/instrumentation/syscalls/README
index 6c235e150d46af6ea59686a6fe6da30e40d95b1b..1e9bec49c5e3a207fb5597030f6657e147d97069 100644 (file)
--- a/instrumentation/syscalls/README
+++ b/instrumentation/syscalls/README
@@ -12,7 +12,7 @@ is expected). See the dmesg output for system call metadata.
 
 Take the dmesg metadata and feed it to lttng-syscalls-generate-headers.sh, e.g.,
 from the instrumentation/syscalls directory. See the script header for
-usage example.
+usage example. It should be run for both the integers and pointers types.
 
 After these are created, we just need to follow the new system call additions,
 no need to regenerate the whole thing, since system calls are only appended to.

diff --git a/instrumentation/syscalls/lttng-syscalls-generate-headers.sh b/instrumentation/syscalls/lttng-syscalls-generate-headers.sh
index 1754ae89faf29bf42af70a4a216a99f071ef836b..4ab4599befc16479465b4a8b5557ede22a3f9da0 100755 (executable)
--- a/instrumentation/syscalls/lttng-syscalls-generate-headers.sh
+++ b/instrumentation/syscalls/lttng-syscalls-generate-headers.sh
@@ -1,8 +1,12 @@
 #!/bin/sh
 
 # Generate system call probe description macros from syscall metadata dump file.
+# The resulting header will be written in the headers subdirectory, in a file name
+# based on the name of the input file. 
+#
 # example usage:
 #
+# lttng-syscalls-generate-headers.sh <type> <input_dir> <input_filename_in_dir> <bitness>
 # lttng-syscalls-generate-headers.sh integers 3.0.4 x86-64-syscalls-3.0.4 64
 # lttng-syscalls-generate-headers.sh pointers 3.0.4 x86-64-syscalls-3.0.4 64