diff options
| author | John Snow <jsnow@redhat.com> | 2025-06-18 12:53:52 -0400 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2025-07-14 10:08:27 +0200 |
| commit | 6c10778826a873b9012d95e63298a6f879debcaa (patch) | |
| tree | 9707775416b8a85c047ef42facefb1c42eb1a3bd /tests | |
| parent | 8d789c8cdb8de2cae39f217b6c9607ac9c036c8c (diff) | |
| download | focaccia-qemu-6c10778826a873b9012d95e63298a6f879debcaa.tar.gz focaccia-qemu-6c10778826a873b9012d95e63298a6f879debcaa.zip | |
docs/sphinx: remove special parsing for freeform sections
Remove the QAPI doc section heading syntax, use plain rST section headings instead. Tests and documentation are updated to match. Interestingly, Plain rST headings work fine before this patch, except for over- and underlining with '=', which the doc parser rejected as invalid QAPI doc section heading in free-form comments. Signed-off-by: John Snow <jsnow@redhat.com> Message-ID: <20250618165353.1980365-5-jsnow@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com> [Add more detail to commit message] Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'tests')
| -rw-r--r-- | tests/qapi-schema/doc-good.json | 10 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-good.out | 10 |
2 files changed, 14 insertions, 6 deletions
diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json index 14b808f909..fac13425b7 100644 --- a/tests/qapi-schema/doc-good.json +++ b/tests/qapi-schema/doc-good.json @@ -8,7 +8,9 @@ 'documentation-exceptions': [ 'Enum', 'Variant1', 'Alternate', 'cmd' ] } } ## -# = Section +# ******* +# Section +# ******* ## ## @@ -16,7 +18,8 @@ ## ## -# == Subsection +# Subsection +# ========== # # *with emphasis* # @var {in braces} @@ -144,7 +147,8 @@ 'if': { 'not': { 'any': [ 'IFONE', 'IFTWO' ] } } } ## -# == Another subsection +# Another subsection +# ================== ## ## diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out index dc8352eed4..04a5507264 100644 --- a/tests/qapi-schema/doc-good.out +++ b/tests/qapi-schema/doc-good.out @@ -55,13 +55,16 @@ event EVT_BOXED Object feature feat3 doc freeform body= -= Section +******* +Section +******* doc freeform body= Just text, no heading. doc freeform body= -== Subsection +Subsection +========== *with emphasis* @var {in braces} @@ -155,7 +158,8 @@ description starts on the same line a feature doc freeform body= -== Another subsection +Another subsection +================== doc symbol=cmd body= |