| Message ID | 20190314180929.27722-2-armbru@redhat.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | trace-events: Clean up | expand |
On 3/14/19 7:09 PM, Markus Armbruster wrote: > Almost all trace-events do so in a comment right at the beginning. It was not obvious at first that "do so" means "consistently point to docs/devel/tracing.txt". > Touch up the ones that don't. > > Signed-off-by: Markus Armbruster <armbru@redhat.com> > --- > accel/kvm/trace-events | 2 +- > accel/tcg/trace-events | 2 +- > hw/i386/xen/trace-events | 2 ++ > hw/rdma/trace-events | 2 +- > hw/rdma/vmw/trace-events | 2 +- > nbd/trace-events | 2 ++ > qapi/trace-events | 2 ++ > scsi/trace-events | 2 ++ > trace-events | 2 +- > 9 files changed, 13 insertions(+), 5 deletions(-) > > diff --git a/accel/kvm/trace-events b/accel/kvm/trace-events > index 8841025d68..33c5b1b3af 100644 > --- a/accel/kvm/trace-events > +++ b/accel/kvm/trace-events > @@ -1,4 +1,4 @@ > -# Trace events for debugging and performance instrumentation > +# See docs/devel/tracing.txt for syntax documentation. > > # kvm-all.c > kvm_ioctl(int type, void *arg) "type 0x%x, arg %p" > diff --git a/accel/tcg/trace-events b/accel/tcg/trace-events > index c22ad60af7..01852217a6 100644 > --- a/accel/tcg/trace-events > +++ b/accel/tcg/trace-events > @@ -1,4 +1,4 @@ > -# Trace events for debugging and performance instrumentation > +# See docs/devel/tracing.txt for syntax documentation. > > # TCG related tracing (mostly disabled by default) > # cpu-exec.c > diff --git a/hw/i386/xen/trace-events b/hw/i386/xen/trace-events > index 8a9077cd4e..8732741541 100644 > --- a/hw/i386/xen/trace-events > +++ b/hw/i386/xen/trace-events > @@ -1,3 +1,5 @@ > +# See docs/devel/tracing.txt for syntax documentation. > + > # hw/i386/xen/xen_platform.c > xen_platform_log(char *s) "xen platform: %s" > > diff --git a/hw/rdma/trace-events b/hw/rdma/trace-events > index c4c202e647..2dbd6d16db 100644 > --- a/hw/rdma/trace-events > +++ b/hw/rdma/trace-events > @@ -1,4 +1,4 @@ > -# See docs/tracing.txt for syntax documentation. > +# See docs/devel/tracing.txt for syntax documentation. > > #hw/rdma/rdma_backend.c > create_ah_cache_hit(uint64_t subnet, uint64_t net_id) "subnet = 0x%"PRIx64" net_id = 0x%"PRIx64 > diff --git a/hw/rdma/vmw/trace-events b/hw/rdma/vmw/trace-events > index b3f9e2b19f..bda6b56abc 100644 > --- a/hw/rdma/vmw/trace-events > +++ b/hw/rdma/vmw/trace-events > @@ -1,4 +1,4 @@ > -# See docs/tracing.txt for syntax documentation. > +# See docs/devel/tracing.txt for syntax documentation. > > # hw/rdma/vmw/pvrdma_main.c > pvrdma_regs_read(uint64_t addr, uint64_t val) "regs[0x%"PRIx64"] = 0x%"PRIx64 > diff --git a/nbd/trace-events b/nbd/trace-events > index 7f10ebd4e0..6db8375c3e 100644 > --- a/nbd/trace-events > +++ b/nbd/trace-events > @@ -1,3 +1,5 @@ > +# See docs/devel/tracing.txt for syntax documentation. > + > # nbd/client.c > nbd_send_option_request(uint32_t opt, const char *name, uint32_t len) "Sending option request %" PRIu32" (%s), len %" PRIu32 > nbd_receive_option_reply(uint32_t option, const char *optname, uint32_t type, const char *typename, uint32_t length) "Received option reply %" PRIu32" (%s), type %" PRIu32" (%s), len %" PRIu32 > diff --git a/qapi/trace-events b/qapi/trace-events > index 70e049ea80..b123c5e302 100644 > --- a/qapi/trace-events > +++ b/qapi/trace-events > @@ -1,3 +1,5 @@ > +# See docs/devel/tracing.txt for syntax documentation. > + > # qapi/qapi-visit-core.c > visit_free(void *v) "v=%p" > visit_complete(void *v, void *opaque) "v=%p opaque=%p" > diff --git a/scsi/trace-events b/scsi/trace-events > index f8a68b11eb..499098e50b 100644 > --- a/scsi/trace-events > +++ b/scsi/trace-events > @@ -1,3 +1,5 @@ > +# See docs/devel/tracing.txt for syntax documentation. > + > # scsi/pr-manager.c > pr_manager_execute(int fd, int cmd, int sa) "fd=%d cmd=0x%02x service action=0x%02x" > pr_manager_run(int fd, int cmd, int sa) "fd=%d cmd=0x%02x service action=0x%02x" > diff --git a/trace-events b/trace-events > index e66afc59e9..b48f417225 100644 > --- a/trace-events > +++ b/trace-events > @@ -1,4 +1,4 @@ > -# Trace events for debugging and performance instrumentation > +# See docs/devel/tracing.txt for syntax documentation. > # > # This file is processed by the tracetool script during the build. > # > Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Philippe Mathieu-Daudé <philmd@redhat.com> writes: > On 3/14/19 7:09 PM, Markus Armbruster wrote: >> Almost all trace-events do so in a comment right at the beginning. > > It was not obvious at first that "do so" means "consistently point to > docs/devel/tracing.txt". > >> Touch up the ones that don't. I see. Clarifying to Almost all trace-events point to docs/devel/tracing.txt in a comment right at the beginning. Touch up the ones that don't. >> Signed-off-by: Markus Armbruster <armbru@redhat.com> >> --- [...] > Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com> Thanks!
diff --git a/accel/kvm/trace-events b/accel/kvm/trace-events index 8841025d68..33c5b1b3af 100644 --- a/accel/kvm/trace-events +++ b/accel/kvm/trace-events @@ -1,4 +1,4 @@ -# Trace events for debugging and performance instrumentation +# See docs/devel/tracing.txt for syntax documentation. # kvm-all.c kvm_ioctl(int type, void *arg) "type 0x%x, arg %p" diff --git a/accel/tcg/trace-events b/accel/tcg/trace-events index c22ad60af7..01852217a6 100644 --- a/accel/tcg/trace-events +++ b/accel/tcg/trace-events @@ -1,4 +1,4 @@ -# Trace events for debugging and performance instrumentation +# See docs/devel/tracing.txt for syntax documentation. # TCG related tracing (mostly disabled by default) # cpu-exec.c diff --git a/hw/i386/xen/trace-events b/hw/i386/xen/trace-events index 8a9077cd4e..8732741541 100644 --- a/hw/i386/xen/trace-events +++ b/hw/i386/xen/trace-events @@ -1,3 +1,5 @@ +# See docs/devel/tracing.txt for syntax documentation. + # hw/i386/xen/xen_platform.c xen_platform_log(char *s) "xen platform: %s" diff --git a/hw/rdma/trace-events b/hw/rdma/trace-events index c4c202e647..2dbd6d16db 100644 --- a/hw/rdma/trace-events +++ b/hw/rdma/trace-events @@ -1,4 +1,4 @@ -# See docs/tracing.txt for syntax documentation. +# See docs/devel/tracing.txt for syntax documentation. #hw/rdma/rdma_backend.c create_ah_cache_hit(uint64_t subnet, uint64_t net_id) "subnet = 0x%"PRIx64" net_id = 0x%"PRIx64 diff --git a/hw/rdma/vmw/trace-events b/hw/rdma/vmw/trace-events index b3f9e2b19f..bda6b56abc 100644 --- a/hw/rdma/vmw/trace-events +++ b/hw/rdma/vmw/trace-events @@ -1,4 +1,4 @@ -# See docs/tracing.txt for syntax documentation. +# See docs/devel/tracing.txt for syntax documentation. # hw/rdma/vmw/pvrdma_main.c pvrdma_regs_read(uint64_t addr, uint64_t val) "regs[0x%"PRIx64"] = 0x%"PRIx64 diff --git a/nbd/trace-events b/nbd/trace-events index 7f10ebd4e0..6db8375c3e 100644 --- a/nbd/trace-events +++ b/nbd/trace-events @@ -1,3 +1,5 @@ +# See docs/devel/tracing.txt for syntax documentation. + # nbd/client.c nbd_send_option_request(uint32_t opt, const char *name, uint32_t len) "Sending option request %" PRIu32" (%s), len %" PRIu32 nbd_receive_option_reply(uint32_t option, const char *optname, uint32_t type, const char *typename, uint32_t length) "Received option reply %" PRIu32" (%s), type %" PRIu32" (%s), len %" PRIu32 diff --git a/qapi/trace-events b/qapi/trace-events index 70e049ea80..b123c5e302 100644 --- a/qapi/trace-events +++ b/qapi/trace-events @@ -1,3 +1,5 @@ +# See docs/devel/tracing.txt for syntax documentation. + # qapi/qapi-visit-core.c visit_free(void *v) "v=%p" visit_complete(void *v, void *opaque) "v=%p opaque=%p" diff --git a/scsi/trace-events b/scsi/trace-events index f8a68b11eb..499098e50b 100644 --- a/scsi/trace-events +++ b/scsi/trace-events @@ -1,3 +1,5 @@ +# See docs/devel/tracing.txt for syntax documentation. + # scsi/pr-manager.c pr_manager_execute(int fd, int cmd, int sa) "fd=%d cmd=0x%02x service action=0x%02x" pr_manager_run(int fd, int cmd, int sa) "fd=%d cmd=0x%02x service action=0x%02x" diff --git a/trace-events b/trace-events index e66afc59e9..b48f417225 100644 --- a/trace-events +++ b/trace-events @@ -1,4 +1,4 @@ -# Trace events for debugging and performance instrumentation +# See docs/devel/tracing.txt for syntax documentation. # # This file is processed by the tracetool script during the build. #
Almost all trace-events do so in a comment right at the beginning. Touch up the ones that don't. Signed-off-by: Markus Armbruster <armbru@redhat.com> --- accel/kvm/trace-events | 2 +- accel/tcg/trace-events | 2 +- hw/i386/xen/trace-events | 2 ++ hw/rdma/trace-events | 2 +- hw/rdma/vmw/trace-events | 2 +- nbd/trace-events | 2 ++ qapi/trace-events | 2 ++ scsi/trace-events | 2 ++ trace-events | 2 +- 9 files changed, 13 insertions(+), 5 deletions(-)