qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 0/2] qapi: Fixes related to change of doc heading markup
@ 2025-07-24  9:17 Markus Armbruster
  2025-07-24  9:17 ` [PATCH 1/2] qapi/accelerator: Fix markup of heading Markus Armbruster
                   ` (2 more replies)
  0 siblings, 3 replies; 4+ messages in thread
From: Markus Armbruster @ 2025-07-24  9:17 UTC (permalink / raw)
  To: qemu-devel; +Cc: jsnow, eblake, philmd

Markus Armbruster (2):
  qapi/accelerator: Fix markup of heading
  tests/qapi-schema: Bury dead test case doc-non-first-section

 qapi/accelerator.json                        | 4 +++-
 tests/qapi-schema/doc-non-first-section.err  | 1 -
 tests/qapi-schema/doc-non-first-section.json | 6 ------
 tests/qapi-schema/doc-non-first-section.out  | 0
 4 files changed, 3 insertions(+), 8 deletions(-)
 delete mode 100644 tests/qapi-schema/doc-non-first-section.err
 delete mode 100644 tests/qapi-schema/doc-non-first-section.json
 delete mode 100644 tests/qapi-schema/doc-non-first-section.out

-- 
2.49.0




^ permalink raw reply	[flat|nested] 4+ messages in thread

* [PATCH 1/2] qapi/accelerator: Fix markup of heading
  2025-07-24  9:17 [PATCH 0/2] qapi: Fixes related to change of doc heading markup Markus Armbruster
@ 2025-07-24  9:17 ` Markus Armbruster
  2025-07-24  9:17 ` [PATCH 2/2] tests/qapi-schema: Bury dead test case doc-non-first-section Markus Armbruster
  2025-07-29 13:13 ` [PATCH 0/2] qapi: Fixes related to change of doc heading markup Markus Armbruster
  2 siblings, 0 replies; 4+ messages in thread
From: Markus Armbruster @ 2025-07-24  9:17 UTC (permalink / raw)
  To: qemu-devel; +Cc: jsnow, eblake, philmd

The docs generated for qapi/accelerator.json shows text "=
Accelerators" instead of a heading.  This is because the patch that
added the heading crossed with the commit that changed heading
markup (commit 6c10778826a "docs/sphinx: remove special parsing for
freeform sections").  Fix the markup.

Fixes: 18da42ee4273 (qapi/accel: Move definitions related to accelerators in their own file)
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qapi/accelerator.json | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/qapi/accelerator.json b/qapi/accelerator.json
index 28d5ff4c49..fb28c8d920 100644
--- a/qapi/accelerator.json
+++ b/qapi/accelerator.json
@@ -4,7 +4,9 @@
 # SPDX-License-Identifier: GPL-2.0-or-later
 
 ##
-# = Accelerators
+# ************
+# Accelerators
+# ************
 ##
 
 { 'include': 'common.json' }
-- 
2.49.0




^ permalink raw reply related	[flat|nested] 4+ messages in thread

* [PATCH 2/2] tests/qapi-schema: Bury dead test case doc-non-first-section
  2025-07-24  9:17 [PATCH 0/2] qapi: Fixes related to change of doc heading markup Markus Armbruster
  2025-07-24  9:17 ` [PATCH 1/2] qapi/accelerator: Fix markup of heading Markus Armbruster
@ 2025-07-24  9:17 ` Markus Armbruster
  2025-07-29 13:13 ` [PATCH 0/2] qapi: Fixes related to change of doc heading markup Markus Armbruster
  2 siblings, 0 replies; 4+ messages in thread
From: Markus Armbruster @ 2025-07-24  9:17 UTC (permalink / raw)
  To: qemu-devel; +Cc: jsnow, eblake, philmd

The test passed when it was added.  However, the commit adding it
neglected to make Meson aware of it, so it never ran automatically.
The test stopped making sense when we changed headings markup, and
ceased to pass then.  It should've been removed then.  Do that now.

Fixes: 6c10778826a8 (docs/sphinx: remove special parsing for freeform sections)
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 tests/qapi-schema/doc-non-first-section.err  | 1 -
 tests/qapi-schema/doc-non-first-section.json | 6 ------
 tests/qapi-schema/doc-non-first-section.out  | 0
 3 files changed, 7 deletions(-)
 delete mode 100644 tests/qapi-schema/doc-non-first-section.err
 delete mode 100644 tests/qapi-schema/doc-non-first-section.json
 delete mode 100644 tests/qapi-schema/doc-non-first-section.out

diff --git a/tests/qapi-schema/doc-non-first-section.err b/tests/qapi-schema/doc-non-first-section.err
deleted file mode 100644
index eeced2bca7..0000000000
--- a/tests/qapi-schema/doc-non-first-section.err
+++ /dev/null
@@ -1 +0,0 @@
-doc-non-first-section.json:5:1: '=' heading must come first in a comment block
diff --git a/tests/qapi-schema/doc-non-first-section.json b/tests/qapi-schema/doc-non-first-section.json
deleted file mode 100644
index 1590876061..0000000000
--- a/tests/qapi-schema/doc-non-first-section.json
+++ /dev/null
@@ -1,6 +0,0 @@
-# = section must be first line
-
-##
-#
-# = Not first
-##
diff --git a/tests/qapi-schema/doc-non-first-section.out b/tests/qapi-schema/doc-non-first-section.out
deleted file mode 100644
index e69de29bb2..0000000000
-- 
2.49.0




^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: [PATCH 0/2] qapi: Fixes related to change of doc heading markup
  2025-07-24  9:17 [PATCH 0/2] qapi: Fixes related to change of doc heading markup Markus Armbruster
  2025-07-24  9:17 ` [PATCH 1/2] qapi/accelerator: Fix markup of heading Markus Armbruster
  2025-07-24  9:17 ` [PATCH 2/2] tests/qapi-schema: Bury dead test case doc-non-first-section Markus Armbruster
@ 2025-07-29 13:13 ` Markus Armbruster
  2 siblings, 0 replies; 4+ messages in thread
From: Markus Armbruster @ 2025-07-29 13:13 UTC (permalink / raw)
  To: qemu-devel; +Cc: jsnow, eblake, philmd

Queued.



^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2025-07-29 13:14 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-07-24  9:17 [PATCH 0/2] qapi: Fixes related to change of doc heading markup Markus Armbruster
2025-07-24  9:17 ` [PATCH 1/2] qapi/accelerator: Fix markup of heading Markus Armbruster
2025-07-24  9:17 ` [PATCH 2/2] tests/qapi-schema: Bury dead test case doc-non-first-section Markus Armbruster
2025-07-29 13:13 ` [PATCH 0/2] qapi: Fixes related to change of doc heading markup Markus Armbruster

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).