cleanup: document 'pipe' syscall override

[lttng-modules.git] / include / instrumentation / syscalls / powerpc-32-syscalls_pointers_override.h

diff --git a/include/instrumentation/syscalls/powerpc-32-syscalls_pointers_override.h b/include/instrumentation/syscalls/powerpc-32-syscalls_pointers_override.h
index fde30d270ff2cdbaf1307c331997077b0e830475..b0006833b2923b3a73da32bb30a1e6563b40a23d 100644 (file)
--- a/include/instrumentation/syscalls/powerpc-32-syscalls_pointers_override.h
+++ b/include/instrumentation/syscalls/powerpc-32-syscalls_pointers_override.h
@@ -4,6 +4,10 @@
 
 #ifndef CREATE_SYSCALL_TABLE
 
+/*
+ * Override 'pipe' to set the output field 'fildes' to an array of 2 integers
+ * instead of the default integer pointer.
+ */
 #define OVERRIDE_32_pipe
 SC_LTTNG_TRACEPOINT_EVENT(pipe,
        TP_PROTO(sc_exit(long ret,) int * fildes),