Commit c263de3f authored by Markus Armbruster's avatar Markus Armbruster Committed by Eric Blake
Browse files

qapi: Streamline boilerplate comment generation 



Every generator has separate boilerplate for .h and .c, and their
differences are boring.  All of them repeat the license note.

Reduce the repetition as follows.  Move common text like the license
note to common open_output(), next to the existing common text there.
For each generator, replace the two separate descriptions by a single
one.

While there, emit an "automatically generated" note into generated
documentation, too.

Signed-off-by: default avatarMarkus Armbruster <armbru@redhat.com>
Reviewed-by: default avatarEric Blake <eblake@redhat.com>
Reviewed-by: default avatarMarc-André Lureau <marcandre.lureau@redhat.com>
Message-Id: <20180211093607.27351-3-armbru@redhat.com>
Signed-off-by: default avatarEric Blake <eblake@redhat.com>
parent 0dd13589

scripts/qapi-commands.py

+3 −23
Original line number Diff line number Diff line
@@ -255,38 +255,18 @@ class QAPISchemaGenCommandVisitor(QAPISchemaVisitor): 


(input_file, output_dir, do_c, do_h, prefix, opts) = parse_command_line()



c_comment = '''

/*

 * schema-defined QMP->QAPI command dispatch

blurb = '''

 * Schema-defined QAPI/QMP commands

 *

 * Copyright IBM, Corp. 2011

 *

 * Authors:

 *  Anthony Liguori   <aliguori@us.ibm.com>

 *

 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.

 * See the COPYING.LIB file in the top-level directory.

 *

 */

'''

h_comment = '''

/*

 * schema-defined QAPI function prototypes

 *

 * Copyright IBM, Corp. 2011

 *

 * Authors:

 *  Anthony Liguori   <aliguori@us.ibm.com>

 *

 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.

 * See the COPYING.LIB file in the top-level directory.

 *

 */

'''



(fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix,

                            'qmp-marshal.c', 'qmp-commands.h',

                            c_comment, h_comment)

                            blurb)



fdef.write(mcgen('''

scripts/qapi-event.py

+3 −23
Original line number Diff line number Diff line
@@ -171,38 +171,18 @@ class QAPISchemaGenEventVisitor(QAPISchemaVisitor): 


(input_file, output_dir, do_c, do_h, prefix, dummy) = parse_command_line()



c_comment = '''

/*

 * schema-defined QAPI event functions

blurb = '''

 * Schema-defined QAPI/QMP events

 *

 * Copyright (c) 2014 Wenchao Xia

 *

 * Authors:

 *  Wenchao Xia   <wenchaoqemu@gmail.com>

 *

 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.

 * See the COPYING.LIB file in the top-level directory.

 *

 */

'''

h_comment = '''

/*

 * schema-defined QAPI event functions

 *

 * Copyright (c) 2014 Wenchao Xia

 *

 * Authors:

 *  Wenchao Xia  <wenchaoqemu@gmail.com>

 *

 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.

 * See the COPYING.LIB file in the top-level directory.

 *

 */

'''



(fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix,

                            'qapi-event.c', 'qapi-event.h',

                            c_comment, h_comment)

                            blurb)



fdef.write(mcgen('''

#include "qemu/osdep.h"

scripts/qapi-introspect.py

+2 −19
Original line number Diff line number Diff line
@@ -176,32 +176,15 @@ for o, a in opts: 
    if o in ('-u', '--unmask-non-abi-names'):

        opt_unmask = True



c_comment = '''

/*

blurb = '''

 * QAPI/QMP schema introspection

 *

 * Copyright (C) 2015 Red Hat, Inc.

 *

 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.

 * See the COPYING.LIB file in the top-level directory.

 *

 */

'''

h_comment = '''

/*

 * QAPI/QMP schema introspection

 *

 * Copyright (C) 2015 Red Hat, Inc.

 *

 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.

 * See the COPYING.LIB file in the top-level directory.

 *

 */

'''



(fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix,

                            'qmp-introspect.c', 'qmp-introspect.h',

                            c_comment, h_comment)

                            blurb)



fdef.write(mcgen('''

#include "qemu/osdep.h"

scripts/qapi-types.py

+3 −23
Original line number Diff line number Diff line
@@ -250,39 +250,19 @@ for o, a in opts: 
    if o in ('-b', '--builtins'):

        do_builtins = True



c_comment = '''

/*

 * deallocation functions for schema-defined QAPI types

blurb = '''

 * Schema-defined QAPI types

 *

 * Copyright IBM, Corp. 2011

 *

 * Authors:

 *  Anthony Liguori   <aliguori@us.ibm.com>

 *  Michael Roth      <mdroth@linux.vnet.ibm.com>

 *

 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.

 * See the COPYING.LIB file in the top-level directory.

 *

 */

'''

h_comment = '''

/*

 * schema-defined QAPI types

 *

 * Copyright IBM, Corp. 2011

 *

 * Authors:

 *  Anthony Liguori   <aliguori@us.ibm.com>

 *

 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.

 * See the COPYING.LIB file in the top-level directory.

 *

 */

'''



(fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix,

                            'qapi-types.c', 'qapi-types.h',

                            c_comment, h_comment)

                            blurb)



fdef.write(mcgen('''

#include "qemu/osdep.h"

scripts/qapi-visit.py

+3 −23
Original line number Diff line number Diff line
@@ -334,38 +334,18 @@ for o, a in opts: 
    if o in ('-b', '--builtins'):

        do_builtins = True



c_comment = '''

/*

 * schema-defined QAPI visitor functions

blurb = '''

 * Schema-defined QAPI visitors

 *

 * Copyright IBM, Corp. 2011

 *

 * Authors:

 *  Anthony Liguori   <aliguori@us.ibm.com>

 *

 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.

 * See the COPYING.LIB file in the top-level directory.

 *

 */

'''

h_comment = '''

/*

 * schema-defined QAPI visitor functions

 *

 * Copyright IBM, Corp. 2011

 *

 * Authors:

 *  Anthony Liguori   <aliguori@us.ibm.com>

 *

 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.

 * See the COPYING.LIB file in the top-level directory.

 *

 */

'''



(fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix,

                            'qapi-visit.c', 'qapi-visit.h',

                            c_comment, h_comment)

                            blurb)



fdef.write(mcgen('''

#include "qemu/osdep.h"