On Thu, Jun 09, 2016 at 05:57:56PM +0100, Daniel P. Berrange wrote: > diff --git a/util/trace-events b/util/trace-events > new file mode 100644 > index 0000000..95a3b3d > --- /dev/null > +++ b/util/trace-events > @@ -0,0 +1,38 @@ > +# Trace events for debugging and performance instrumentation > +# > +# This file is processed by the tracetool script during the build. > +# > +# To add a new trace event: > +# > +# 1. Choose a name for the trace event. Declare its arguments and format > +# string. > +# > +# 2. Call the trace event from code using trace_##name, e.g. multiwrite_cb() > -> > +# trace_multiwrite_cb(). The source file must #include "trace.h". > +# > +# Format of a trace event: > +# > +# [disable] <name>(<type1> <arg1>[, <type2> <arg2>] ...) "<format-string>" > +# > +# Example: g_malloc(size_t size) "size %zu" > +# > +# The "disable" keyword will build without the trace event. > +# > +# The <name> must be a valid as a C function name. > +# > +# Types should be standard C types. Use void * for pointers because the > trace > +# system may not have the necessary headers included. > +# > +# The <format-string> should be a sprintf()-compatible format string.
Should we just say: # See docs/trace-events.txt for syntax documentation. That way we can avoid a lot of boilerplate and this documentation can live in docs/.
signature.asc
Description: PGP signature
