qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: "Alex Bennée" <alex.bennee@linaro.org>
To: qemu-devel@nongnu.org, Stefan Hajnoczi <stefanha@redhat.com>
Cc: "Riku Voipio" <riku.voipio@iki.fi>,
	"Markus Armbruster" <armbru@redhat.com>,
	"Kyle Evans" <kevans@freebsd.org>,
	"Eduardo Habkost" <eduardo@habkost.net>,
	"Warner Losh" <imp@bsdimp.com>,
	"Richard Henderson" <richard.henderson@linaro.org>,
	"Marcel Apfelbaum" <marcel.apfelbaum@gmail.com>,
	"Greg Kurz" <groug@kaod.org>,
	"Philippe Mathieu-Daudé" <philmd@linaro.org>,
	"Eric Blake" <eblake@redhat.com>,
	libvir-list@redhat.com,
	"Christian Schoenebeck" <qemu_oss@crudebyte.com>,
	"Paolo Bonzini" <pbonzini@redhat.com>,
	"Michael Roth" <michael.roth@amd.com>,
	"Yanan Wang" <wangyanan55@huawei.com>,
	"Alex Bennée" <alex.bennee@linaro.org>
Subject: [PATCH v6 04/11] scripts/qapi: document the tool that generated the file
Date: Fri, 26 May 2023 17:53:54 +0100	[thread overview]
Message-ID: <20230526165401.574474-5-alex.bennee@linaro.org> (raw)
In-Reply-To: <20230526165401.574474-1-alex.bennee@linaro.org>

This makes it a little easier for developers to find where things
where being generated.

Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Message-Id: <20230524133952.3971948-5-alex.bennee@linaro.org>

---
v6
  - use Markus' suggestion for prettier wrapping lines
  - drop un-needed str()
---
 scripts/qapi/gen.py | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/scripts/qapi/gen.py b/scripts/qapi/gen.py
index 8f8f784f4a..70bc576a10 100644
--- a/scripts/qapi/gen.py
+++ b/scripts/qapi/gen.py
@@ -13,6 +13,7 @@
 
 from contextlib import contextmanager
 import os
+import sys
 import re
 from typing import (
     Dict,
@@ -162,7 +163,7 @@ def __init__(self, fname: str, blurb: str, pydoc: str):
 
     def _top(self) -> str:
         return mcgen('''
-/* AUTOMATICALLY GENERATED, DO NOT MODIFY */
+/* AUTOMATICALLY GENERATED by %(tool)s DO NOT MODIFY */
 
 /*
 %(blurb)s
@@ -174,6 +175,7 @@ def _top(self) -> str:
  */
 
 ''',
+                     tool=os.path.basename(sys.argv[0]),
                      blurb=self._blurb, copyright=self._copyright)
 
     def _bottom(self) -> str:
@@ -195,7 +197,10 @@ def _bottom(self) -> str:
 
 class QAPIGenTrace(QAPIGen):
     def _top(self) -> str:
-        return super()._top() + '# AUTOMATICALLY GENERATED, DO NOT MODIFY\n\n'
+        return (super()._top()
+                + '# AUTOMATICALLY GENERATED by '
+                + os.path.basename(sys.argv[0])
+                + ', DO NOT MODIFY\n\n')
 
 
 @contextmanager
-- 
2.39.2



  parent reply	other threads:[~2023-05-26 16:56 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-05-26 16:53 [PATCH v6 00/11] tracing: remove dynamic vcpu state Alex Bennée
2023-05-26 16:53 ` [PATCH v6 01/11] *-user: remove the guest_user_syscall tracepoints Alex Bennée
2023-05-26 16:53 ` [PATCH v6 02/11] trace-events: remove the remaining vcpu trace events Alex Bennée
2023-05-26 16:53 ` [PATCH v6 03/11] trace: remove vcpu_id from the TraceEvent structure Alex Bennée
2023-05-26 16:53 ` Alex Bennée [this message]
2023-05-26 16:53 ` [PATCH v6 05/11] docs/deprecated: move QMP events bellow QMP command section Alex Bennée
2023-05-31 17:20   ` Stefan Hajnoczi
2023-05-26 16:53 ` [PATCH v6 06/11] qapi: make the vcpu parameters deprecated for 8.1 Alex Bennée
2023-05-26 16:53 ` [PATCH v6 07/11] trace: remove code that depends on setting vcpu Alex Bennée
2023-05-26 16:53 ` [PATCH v6 08/11] trace: remove control-vcpu.h Alex Bennée
2023-05-26 16:53 ` [PATCH v6 09/11] tcg: remove the final vestiges of dstate Alex Bennée
2023-05-26 16:54 ` [PATCH v6 10/11] hw/9pfs: use qemu_xxhash4 Alex Bennée
2023-05-26 16:54 ` [PATCH v6 11/11] accel/tcg: include cs_base in our hash calculations Alex Bennée

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=20230526165401.574474-5-alex.bennee@linaro.org \
    --to=alex.bennee@linaro.org \
    --cc=armbru@redhat.com \
    --cc=eblake@redhat.com \
    --cc=eduardo@habkost.net \
    --cc=groug@kaod.org \
    --cc=imp@bsdimp.com \
    --cc=kevans@freebsd.org \
    --cc=libvir-list@redhat.com \
    --cc=marcel.apfelbaum@gmail.com \
    --cc=michael.roth@amd.com \
    --cc=pbonzini@redhat.com \
    --cc=philmd@linaro.org \
    --cc=qemu-devel@nongnu.org \
    --cc=qemu_oss@crudebyte.com \
    --cc=richard.henderson@linaro.org \
    --cc=riku.voipio@iki.fi \
    --cc=stefanha@redhat.com \
    --cc=wangyanan55@huawei.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).