From eafcf0ad62421fedc6ae922368d8b7b1edaaeb92 Mon Sep 17 00:00:00 2001 From: Yannick Brosseau Date: Mon, 8 Jul 2013 12:44:11 -0400 Subject: [PATCH] Improve documentation of the syscall extractor script Signed-off-by: Yannick Brosseau Signed-off-by: Mathieu Desnoyers --- instrumentation/syscalls/README | 2 +- instrumentation/syscalls/lttng-syscalls-generate-headers.sh | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/instrumentation/syscalls/README b/instrumentation/syscalls/README index 6c235e15..1e9bec49 100644 --- 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 1754ae89..4ab4599b 100755 --- 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 # 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 -- 2.34.1