[lttng-dev] [LTTng-module patch] Improve documentation of the syscall extractor script

[Mathieu Desnoyers]

merged, thanks!

* Yannick Brosseau (yannick.brosseau at gmail.com) wrote:
> Signed-off-by: Yannick Brosseau <yannick.brosseau at gmail.com>
> ---
>  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 6c235e1..1e9bec4 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 1754ae8..4ab4599 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 <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
>  
> -- 
> 1.7.10.4
> 
> 
> _______________________________________________
> lttng-dev mailing list
> lttng-dev at lists.lttng.org
> http://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev

-- 
Mathieu Desnoyers
EfficiOS Inc.
http://www.efficios.com