Markus Armbruster
c263de3f41
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: Markus Armbruster <armbru@redhat.com >
Reviewed-by: Eric Blake <eblake@redhat.com >
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com >
Message-Id: <20180211093607.27351-3-armbru@redhat.com >
Signed-off-by: Eric Blake <eblake@redhat.com >
2018-03-02 13:14:08 -06:00
Markus Armbruster
76eb6b60ed
qapi2texi: Simplify representation of section text
...
Use a string instead of a list of strings. While there, generate
fewer superfluous blank lines.
Signed-off-by: Markus Armbruster <armbru@redhat.com >
Message-Id: <20171002141341.24616-10-armbru@redhat.com >
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com >
2017-12-20 19:18:33 +01:00
Markus Armbruster
09331fced1
qapi: Simplify representation of QAPIDoc section text
...
Use a string instead of a list of strings.
This makes qapi2texi.py generate additional blank lines. They're
harmless, and the next commit will get rid of them again.
Signed-off-by: Markus Armbruster <armbru@redhat.com >
Message-Id: <20171002141341.24616-9-armbru@redhat.com >
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com >
2017-12-20 19:18:33 +01:00
Markus Armbruster
cfa438ff53
tests/qapi-schema/doc-bad-section: New, factored out of doc-good
...
A negative test case crept into doc-good.json: invalid use of section
markup we currently fail to reject. Move this into its own
doc-bad-section.json.
Signed-off-by: Markus Armbruster <armbru@redhat.com >
Message-Id: <20171002141341.24616-6-armbru@redhat.com >
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com >
2017-12-20 19:18:33 +01:00
Markus Armbruster
c32617a194
qapi2texi: Fix translation of *strong* and _emphasized_
...
Signed-off-by: Markus Armbruster <armbru@redhat.com >
Message-Id: <1490015515-25851-7-git-send-email-armbru@redhat.com >
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com >
2017-03-21 10:42:58 +01:00
Markus Armbruster
80d1f2e4a5
tests/qapi-schema: Systematic positive doc comment tests
...
We have a number of negative tests, but we don't have systematic
positive coverage. Fix that.
Signed-off-by: Markus Armbruster <armbru@redhat.com >
Message-Id: <1490015515-25851-6-git-send-email-armbru@redhat.com >
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com >
2017-03-21 10:42:55 +01:00
