All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Daniel P. Berrangé" <berrange@redhat.com>
To: Markus Armbruster <armbru@redhat.com>
Cc: qemu-devel@nongnu.org, Stefan Hajnoczi <stefanha@redhat.com>
Subject: Re: tracing.rst neglects to document syntax of trace-events files
Date: Tue, 18 Jan 2022 09:02:35 +0000	[thread overview]
Message-ID: <YeaCFxnGltxc5uFR@redhat.com> (raw)
In-Reply-To: <87zgntpi3t.fsf@dusky.pond.sub.org>

On Tue, Jan 18, 2022 at 09:23:50AM +0100, Markus Armbruster wrote:
> Almost[*] all trace-events files start with this line:
> 
>     # See docs/devel/tracing.rst for syntax documentation.
> 
> But I can't find syntax documentation there.

In that doc, under the heading "Declaring trace events", is a wordy
paragraph that looks like it was attempting to fill this need,
especially the last part.

[quote]
Each event declaration will start with the event name, then its arguments,
finally a format string for pretty-printing. For example::

    qemu_vmalloc(size_t size, void *ptr) "size %zu ptr %p"
    qemu_vfree(void *ptr) "ptr %p"
[/quote]

It certainly has plenty of scope for improvement though !

Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|



  reply	other threads:[~2022-01-18  9:07 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-01-18  8:23 tracing.rst neglects to document syntax of trace-events files Markus Armbruster
2022-01-18  9:02 ` Daniel P. Berrangé [this message]
2022-01-26 13:11   ` Stefan Hajnoczi

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=YeaCFxnGltxc5uFR@redhat.com \
    --to=berrange@redhat.com \
    --cc=armbru@redhat.com \
    --cc=qemu-devel@nongnu.org \
    --cc=stefanha@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.