| Message ID | 20171002152552.27999-2-armbru@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | Command line QAPIfication | expand |
On Mon, Oct 2, 2017 at 5:25 PM, Markus Armbruster <armbru@redhat.com> wrote: > Demonstrates a qapi2texi.py bug: it can fail to escape '@'. > > Signed-off-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com> > --- > tests/qapi-schema/doc-good.json | 3 +++ > tests/qapi-schema/doc-good.out | 3 +++ > tests/qapi-schema/doc-good.texi | 4 ++++ > 3 files changed, 10 insertions(+) > > diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json > index 97ab4625ff..44098d7f1a 100644 > --- a/tests/qapi-schema/doc-good.json > +++ b/tests/qapi-schema/doc-good.json > @@ -10,6 +10,7 @@ > # > # *strong* _with emphasis_ > # @var {in braces} > +# lone @ BUG: gets passed to Texinfo unescaped > # * List item one > # - Two, multiple > # lines > @@ -46,6 +47,7 @@ > # <- out > # Examples: > # - *verbatim* > +# - @at sign > # - {braces} > ## > > @@ -115,6 +117,7 @@ > # <- out > # Examples: > # - *verbatim* > +# - @at sign BUG: gets passed to Texinfo unescaped > # - {braces} > # Since: 2.10 > ## > diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out > index 1d2c250527..b732b81119 100644 > --- a/tests/qapi-schema/doc-good.out > +++ b/tests/qapi-schema/doc-good.out > @@ -38,6 +38,7 @@ doc freeform > > *strong* _with emphasis_ > @var {in braces} > +lone @ BUG: gets passed to Texinfo unescaped > * List item one > - Two, multiple > lines > @@ -74,6 +75,7 @@ Example: > <- out > Examples: > - *verbatim* > +- @at sign > - {braces} > doc symbol=Enum > body= > @@ -136,6 +138,7 @@ Duis aute irure dolor > <- out > section=Examples > - *verbatim* > +- @at sign BUG: gets passed to Texinfo unescaped > - {braces} > section=Since > 2.10 > diff --git a/tests/qapi-schema/doc-good.texi b/tests/qapi-schema/doc-good.texi > index 1778312581..840a492249 100644 > --- a/tests/qapi-schema/doc-good.texi > +++ b/tests/qapi-schema/doc-good.texi > @@ -4,6 +4,7 @@ > > @strong{strong} @emph{with emphasis} > @code{var} @{in braces@} > +lone @ BUG: gets passed to Texinfo unescaped > @itemize @bullet > @item > List item one > @@ -69,6 +70,8 @@ Examples: > @item > @strong{verbatim} > @item > +@code{at} sign > +@item > @{braces@} > @end itemize > > @@ -206,6 +209,7 @@ Duis aute irure dolor > @b{Examples:} > @example > - *verbatim* > +- @at sign BUG: gets passed to Texinfo unescaped > - @{braces@} > @end example > > -- > 2.13.6 > >
diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json index 97ab4625ff..44098d7f1a 100644 --- a/tests/qapi-schema/doc-good.json +++ b/tests/qapi-schema/doc-good.json @@ -10,6 +10,7 @@ # # *strong* _with emphasis_ # @var {in braces} +# lone @ BUG: gets passed to Texinfo unescaped # * List item one # - Two, multiple # lines @@ -46,6 +47,7 @@ # <- out # Examples: # - *verbatim* +# - @at sign # - {braces} ## @@ -115,6 +117,7 @@ # <- out # Examples: # - *verbatim* +# - @at sign BUG: gets passed to Texinfo unescaped # - {braces} # Since: 2.10 ## diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out index 1d2c250527..b732b81119 100644 --- a/tests/qapi-schema/doc-good.out +++ b/tests/qapi-schema/doc-good.out @@ -38,6 +38,7 @@ doc freeform *strong* _with emphasis_ @var {in braces} +lone @ BUG: gets passed to Texinfo unescaped * List item one - Two, multiple lines @@ -74,6 +75,7 @@ Example: <- out Examples: - *verbatim* +- @at sign - {braces} doc symbol=Enum body= @@ -136,6 +138,7 @@ Duis aute irure dolor <- out section=Examples - *verbatim* +- @at sign BUG: gets passed to Texinfo unescaped - {braces} section=Since 2.10 diff --git a/tests/qapi-schema/doc-good.texi b/tests/qapi-schema/doc-good.texi index 1778312581..840a492249 100644 --- a/tests/qapi-schema/doc-good.texi +++ b/tests/qapi-schema/doc-good.texi @@ -4,6 +4,7 @@ @strong{strong} @emph{with emphasis} @code{var} @{in braces@} +lone @ BUG: gets passed to Texinfo unescaped @itemize @bullet @item List item one @@ -69,6 +70,8 @@ Examples: @item @strong{verbatim} @item +@code{at} sign +@item @{braces@} @end itemize @@ -206,6 +209,7 @@ Duis aute irure dolor @b{Examples:} @example - *verbatim* +- @at sign BUG: gets passed to Texinfo unescaped - @{braces@} @end example
Demonstrates a qapi2texi.py bug: it can fail to escape '@'. Signed-off-by: Markus Armbruster <armbru@redhat.com> --- tests/qapi-schema/doc-good.json | 3 +++ tests/qapi-schema/doc-good.out | 3 +++ tests/qapi-schema/doc-good.texi | 4 ++++ 3 files changed, 10 insertions(+)