Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
scripts/qapi: document the tool that generated the file
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: 20230526165401.574474-5-alex.bennee@linaro.org
Message-Id: <20230524133952.3971948-5-alex.bennee@linaro.org>
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
  • Loading branch information
stsquad authored and Stefan Hajnoczi committed May 31, 2023
1 parent 3204527 commit 3aa7977
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions scripts/qapi/gen.py
Expand Up @@ -13,6 +13,7 @@

from contextlib import contextmanager
import os
import sys
import re
from typing import (
Dict,
Expand Down Expand Up @@ -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
Expand All @@ -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:
Expand All @@ -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
Expand Down

0 comments on commit 3aa7977

Please sign in to comment.