From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: michael.roth@amd.com, peter.maydell@linaro.org, jsnow@redhat.com
Subject: [PATCH 3/7] qapi: Fix dangling references to docs/devel/qapi-code-gen.txt
Date: Sat, 20 Jan 2024 10:53:23 +0100 [thread overview]
Message-ID: <20240120095327.666239-4-armbru@redhat.com> (raw)
In-Reply-To: <20240120095327.666239-1-armbru@redhat.com>
Conversion of docs/devel/qapi-code-gen.txt to ReST left several
dangling references behind. Fix them to point to
docs/devel/qapi-code-gen.rst.
Fixes: f7aa076dbdfc (docs: convert qapi-code-gen.txt to ReST)
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
docs/devel/writing-monitor-commands.rst | 2 +-
qapi/introspect.json | 4 ++--
include/qapi/visitor.h | 2 +-
include/qemu/yank.h | 2 +-
qapi/qapi-util.c | 2 +-
util/yank.c | 2 +-
scripts/qapi/parser.py | 2 +-
7 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/docs/devel/writing-monitor-commands.rst b/docs/devel/writing-monitor-commands.rst
index 3b3d5517a2..b6ee4fa063 100644
--- a/docs/devel/writing-monitor-commands.rst
+++ b/docs/devel/writing-monitor-commands.rst
@@ -8,7 +8,7 @@ This document doesn't discuss QMP protocol level details, nor does it dive
into the QAPI framework implementation.
For an in-depth introduction to the QAPI framework, please refer to
-docs/devel/qapi-code-gen.txt. For the QMP protocol, see the
+:doc:`qapi-code-gen`. For the QMP protocol, see the
:doc:`/interop/qmp-spec`.
New commands may be implemented in QMP only. New HMP commands should be
diff --git a/qapi/introspect.json b/qapi/introspect.json
index 9173e60fdd..ebc4e199d2 100644
--- a/qapi/introspect.json
+++ b/qapi/introspect.json
@@ -260,8 +260,8 @@
# Additional SchemaInfo members for meta-type 'alternate'.
#
# @members: the alternate type's members, in no particular order. The
-# members' wire encoding is distinct, see
-# docs/devel/qapi-code-gen.txt section Alternate types.
+# members' wire encoding is distinct, see :doc:`qapi-code-gen`
+# section Alternate types.
#
# On the wire, this can be any of the members.
#
diff --git a/include/qapi/visitor.h b/include/qapi/visitor.h
index d53a84c9ba..27b85d4700 100644
--- a/include/qapi/visitor.h
+++ b/include/qapi/visitor.h
@@ -39,7 +39,7 @@
* limitations; see the documentation for each visitor for more
* details on what it supports. Also, see visitor-impl.h for the
* callback contracts implemented by each visitor, and
- * docs/devel/qapi-code-gen.txt for more about the QAPI code
+ * docs/devel/qapi-code-gen.rst for more about the QAPI code
* generator.
*
* All of the visitors are created via:
diff --git a/include/qemu/yank.h b/include/qemu/yank.h
index 1907150933..3d88af6996 100644
--- a/include/qemu/yank.h
+++ b/include/qemu/yank.h
@@ -45,7 +45,7 @@ void yank_unregister_instance(const YankInstance *instance);
* yank_register_function: Register a yank function
*
* This registers a yank function. All limitations of qmp oob commands apply
- * to the yank function as well. See docs/devel/qapi-code-gen.txt under
+ * to the yank function as well. See docs/devel/qapi-code-gen.rst under
* "An OOB-capable command handler must satisfy the following conditions".
*
* This function is thread-safe.
diff --git a/qapi/qapi-util.c b/qapi/qapi-util.c
index 63596e11c5..65a7d18437 100644
--- a/qapi/qapi-util.c
+++ b/qapi/qapi-util.c
@@ -112,7 +112,7 @@ bool qapi_bool_parse(const char *name, const char *value, bool *obj, Error **err
* It may be prefixed by __RFQDN_ (downstream extension), where RFQDN
* may contain only letters, digits, hyphen and period.
* The special exception for enumeration names is not implemented.
- * See docs/devel/qapi-code-gen.txt for more on QAPI naming rules.
+ * See docs/devel/qapi-code-gen.rst for more on QAPI naming rules.
* Keep this consistent with scripts/qapi-gen.py!
* If @complete, the parse fails unless it consumes @str completely.
* Return its length on success, -1 on failure.
diff --git a/util/yank.c b/util/yank.c
index abf47c346d..eaac50539c 100644
--- a/util/yank.c
+++ b/util/yank.c
@@ -35,7 +35,7 @@ typedef struct YankInstanceEntry YankInstanceEntry;
/*
* This lock protects the yank_instance_list below. Because it's taken by
* OOB-capable commands, it must be "fast", i.e. it may only be held for a
- * bounded, short time. See docs/devel/qapi-code-gen.txt for additional
+ * bounded, short time. See docs/devel/qapi-code-gen.rst for additional
* information.
*/
static QemuMutex yank_lock;
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
index bf31018aef..48cd55a38c 100644
--- a/scripts/qapi/parser.py
+++ b/scripts/qapi/parser.py
@@ -71,7 +71,7 @@ class QAPISchemaParser:
Parse QAPI schema source.
Parse a JSON-esque schema file and process directives. See
- qapi-code-gen.txt section "Schema Syntax" for the exact syntax.
+ qapi-code-gen.rst section "Schema Syntax" for the exact syntax.
Grammatical validation is handled later by `expr.check_exprs()`.
:param fname: Source file name.
--
2.43.0
next prev parent reply other threads:[~2024-01-20 9:54 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-20 9:53 [PATCH 0/7] qapi qmp: Documentation fixes Markus Armbruster
2024-01-20 9:53 ` [PATCH 1/7] docs/devel/qapi-code-gen: Fix missing ':' in tagged section docs Markus Armbruster
2024-01-20 9:53 ` [PATCH 2/7] docs: Replace dangling references to docs/interop/qmp-intro.txt Markus Armbruster
2024-01-20 9:53 ` Markus Armbruster [this message]
2024-01-20 9:53 ` [PATCH 4/7] docs/interop/bitmaps: Clean up a reference to qemu-qmp-ref Markus Armbruster
2024-02-01 21:45 ` John Snow
2024-02-01 21:47 ` John Snow
2024-01-20 9:53 ` [PATCH 5/7] qapi: Fix mangled "Returns" sections in documentation Markus Armbruster
2024-01-20 9:53 ` [PATCH 6/7] qapi: Indent tagged doc comment sections properly Markus Armbruster
2024-01-20 9:53 ` [PATCH 7/7] qapi: Fix malformed "Since:" section tags (again) Markus Armbruster
2024-01-20 23:21 ` Philippe Mathieu-Daudé
2024-01-25 19:48 ` [PATCH 0/7] qapi qmp: Documentation fixes Eric Blake
2024-01-26 6:08 ` Markus Armbruster
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240120095327.666239-4-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=jsnow@redhat.com \
--cc=michael.roth@amd.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).