mirrors/qemu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

tests/qapi-schema: Fix test 'QAPI rST doc'

Browse Source 
The test compares Sphinx plain-text output against a golden reference.
To work on Windows hosts, it filters out carriage returns in both
files.  Unfortunately, the filter doesn't work: it creates an empty
file.  Comparing empty files always succeeds.

Fix the filter, and update the golden reference to current Sphinx
output.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240216145841.2099240-2-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
Markus Armbruster 2024-02-16 15:58:25 +01:00
parent 3cee17e739
commit 976474fdb2
2 changed files with 15 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
tests/qapi-schema/doc-good.txt
View File

@ -44,7 +44,7 @@ Values
~~~~~~
"one" (**If: **"IFONE")
The _one_ {and only}
The _one_ {and only}, description on the same line
"two"
Not documented
@ -76,7 +76,7 @@ Members
~~~~~~~
"base1": "Enum"
the first member
description starts on a new line, minimally indented
If
@ -90,7 +90,9 @@ If
A paragraph
Another paragraph (but no "var": line)
Another paragraph
"var1" is undocumented
Members
@ -141,7 +143,8 @@ Members
~~~~~~~
"i": "int"
an integer "b" is undocumented
description starts on the same line remainder indented the same "b"
is undocumented
"b": "boolean"
Not documented
@ -172,10 +175,10 @@ Arguments
~~~~~~~~~
"arg1": "int"
the first argument
description starts on a new line, indented
"arg2": "string" (optional)
the second argument
description starts on the same line remainder indented differently
"arg3": "boolean"
Not documented
@ -203,12 +206,6 @@ Returns
"Object"
TODO
~~~~
frobnicate
Notes
~~~~~

10
tests/qapi-schema/meson.build
View File

@ -273,15 +273,17 @@ if build_docs
output: ['doc-good.txt.nocr'],
input: qapi_doc_out[0],
build_by_default: true,
command: [remove_cr, '@INPUT@'],
capture: true)
command: [remove_cr],
capture: true,
feed: true)
qapi_doc_ref_nocr = custom_target('QAPI rST doc reference newline-sanitized',
output: ['doc-good.ref.nocr'],
input: files('doc-good.txt'),
build_by_default: true,
command: [remove_cr, '@INPUT@'],
capture: true)
command: [remove_cr],
capture: true,
feed: true)
test('QAPI rST doc', diff, args: ['-u', qapi_doc_ref_nocr[0], qapi_doc_out_nocr[0]],
suite: ['qapi-schema', 'qapi-doc'])