| Message ID | 20171002141341.24616-8-armbru@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | qapi: Cleanups around qapi2texi | expand |
On Mon, Oct 2, 2017 at 4:13 PM, Markus Armbruster <armbru@redhat.com> wrote: > We have two representations of sections without a name: the main > section uses name=None, the others name=''. Standardize on name=None. > > Signed-off-by: Markus Armbruster <armbru@redhat.com> > --- > scripts/qapi.py | 2 +- > scripts/qapi2texi.py | 2 +- > tests/qapi-schema/doc-bad-section.out | 2 +- > tests/qapi-schema/doc-good.out | 2 +- > 4 files changed, 4 insertions(+), 4 deletions(-) > > diff --git a/scripts/qapi.py b/scripts/qapi.py > index 2f2738f562..2137067b48 100644 > --- a/scripts/qapi.py > +++ b/scripts/qapi.py > @@ -204,7 +204,7 @@ class QAPIDoc(object): > self.section = QAPIDoc.ArgSection(name) > self.args[name] = self.section > > - def _start_section(self, name=''): > + def _start_section(self, name=None): > if name in ('Returns', 'Since') and self.has_section(name): > raise QAPIParseError(self.parser, > "Duplicated '%s' section" % name) > diff --git a/scripts/qapi2texi.py b/scripts/qapi2texi.py > index f876d9a174..f16fa1ba53 100755 > --- a/scripts/qapi2texi.py > +++ b/scripts/qapi2texi.py > @@ -184,7 +184,7 @@ def texi_sections(doc): > # prefer @b over @strong, so txt doesn't translate it to *Foo:* > body += '\n\n@b{%s:}\n' % section.name > text = str(section) > - if section.name.startswith('Example'): > + if section.name and section.name.startswith('Example'): > body += texi_example(text) > else: > body += texi_format(text) > diff --git a/tests/qapi-schema/doc-bad-section.out b/tests/qapi-schema/doc-bad-section.out > index 6fce84dd34..089bde1381 100644 > --- a/tests/qapi-schema/doc-bad-section.out > +++ b/tests/qapi-schema/doc-bad-section.out > @@ -9,5 +9,5 @@ doc symbol=Enum > The _one_ {and only} > arg=two > > - section= > + section=None > @two is undocumented > diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out > index c55e394e8a..1d2c250527 100644 > --- a/tests/qapi-schema/doc-good.out > +++ b/tests/qapi-schema/doc-good.out > @@ -82,7 +82,7 @@ doc symbol=Enum > The _one_ {and only} > arg=two > > - section= > + section=None > @two is undocumented > doc symbol=Base > body= > -- > 2.13.6 > >
On Mon, Oct 2, 2017 at 4:13 PM, Markus Armbruster <armbru@redhat.com> wrote: > We have two representations of sections without a name: the main > section uses name=None, the others name=''. Standardize on name=None. > > Signed-off-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com> > --- > scripts/qapi.py | 2 +- > scripts/qapi2texi.py | 2 +- > tests/qapi-schema/doc-bad-section.out | 2 +- > tests/qapi-schema/doc-good.out | 2 +- > 4 files changed, 4 insertions(+), 4 deletions(-) > > diff --git a/scripts/qapi.py b/scripts/qapi.py > index 2f2738f562..2137067b48 100644 > --- a/scripts/qapi.py > +++ b/scripts/qapi.py > @@ -204,7 +204,7 @@ class QAPIDoc(object): > self.section = QAPIDoc.ArgSection(name) > self.args[name] = self.section > > - def _start_section(self, name=''): > + def _start_section(self, name=None): > if name in ('Returns', 'Since') and self.has_section(name): > raise QAPIParseError(self.parser, > "Duplicated '%s' section" % name) > diff --git a/scripts/qapi2texi.py b/scripts/qapi2texi.py > index f876d9a174..f16fa1ba53 100755 > --- a/scripts/qapi2texi.py > +++ b/scripts/qapi2texi.py > @@ -184,7 +184,7 @@ def texi_sections(doc): > # prefer @b over @strong, so txt doesn't translate it to *Foo:* > body += '\n\n@b{%s:}\n' % section.name > text = str(section) > - if section.name.startswith('Example'): > + if section.name and section.name.startswith('Example'): > body += texi_example(text) > else: > body += texi_format(text) > diff --git a/tests/qapi-schema/doc-bad-section.out b/tests/qapi-schema/doc-bad-section.out > index 6fce84dd34..089bde1381 100644 > --- a/tests/qapi-schema/doc-bad-section.out > +++ b/tests/qapi-schema/doc-bad-section.out > @@ -9,5 +9,5 @@ doc symbol=Enum > The _one_ {and only} > arg=two > > - section= > + section=None > @two is undocumented > diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out > index c55e394e8a..1d2c250527 100644 > --- a/tests/qapi-schema/doc-good.out > +++ b/tests/qapi-schema/doc-good.out > @@ -82,7 +82,7 @@ doc symbol=Enum > The _one_ {and only} > arg=two > > - section= > + section=None > @two is undocumented > doc symbol=Base > body= > -- > 2.13.6 > >
diff --git a/scripts/qapi.py b/scripts/qapi.py index 2f2738f562..2137067b48 100644 --- a/scripts/qapi.py +++ b/scripts/qapi.py @@ -204,7 +204,7 @@ class QAPIDoc(object): self.section = QAPIDoc.ArgSection(name) self.args[name] = self.section - def _start_section(self, name=''): + def _start_section(self, name=None): if name in ('Returns', 'Since') and self.has_section(name): raise QAPIParseError(self.parser, "Duplicated '%s' section" % name) diff --git a/scripts/qapi2texi.py b/scripts/qapi2texi.py index f876d9a174..f16fa1ba53 100755 --- a/scripts/qapi2texi.py +++ b/scripts/qapi2texi.py @@ -184,7 +184,7 @@ def texi_sections(doc): # prefer @b over @strong, so txt doesn't translate it to *Foo:* body += '\n\n@b{%s:}\n' % section.name text = str(section) - if section.name.startswith('Example'): + if section.name and section.name.startswith('Example'): body += texi_example(text) else: body += texi_format(text) diff --git a/tests/qapi-schema/doc-bad-section.out b/tests/qapi-schema/doc-bad-section.out index 6fce84dd34..089bde1381 100644 --- a/tests/qapi-schema/doc-bad-section.out +++ b/tests/qapi-schema/doc-bad-section.out @@ -9,5 +9,5 @@ doc symbol=Enum The _one_ {and only} arg=two - section= + section=None @two is undocumented diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out index c55e394e8a..1d2c250527 100644 --- a/tests/qapi-schema/doc-good.out +++ b/tests/qapi-schema/doc-good.out @@ -82,7 +82,7 @@ doc symbol=Enum The _one_ {and only} arg=two - section= + section=None @two is undocumented doc symbol=Base body=
We have two representations of sections without a name: the main section uses name=None, the others name=''. Standardize on name=None. Signed-off-by: Markus Armbruster <armbru@redhat.com> --- scripts/qapi.py | 2 +- scripts/qapi2texi.py | 2 +- tests/qapi-schema/doc-bad-section.out | 2 +- tests/qapi-schema/doc-good.out | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-)