From: Eduardo Habkost <ehabkost@redhat.com>
To: qemu-devel@nongnu.org, Peter Maydell <peter.maydell@linaro.org>
Cc: "Paolo Bonzini" <pbonzini@redhat.com>,
"Daniel P. Berrangé" <berrange@redhat.com>,
"Eduardo Habkost" <ehabkost@redhat.com>
Subject: [PULL 15/21] docs/devel/qom: Remove usage of <code>
Date: Mon, 5 Oct 2020 17:09:54 -0400 [thread overview]
Message-ID: <20201005211000.710404-16-ehabkost@redhat.com> (raw)
In-Reply-To: <20201005211000.710404-1-ehabkost@redhat.com>
<code> is not valid reST syntax.
Function @argument references don't need additional markup, so
just remove <code></code>.
Constants were changed to use reST ``code`` syntax
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
Message-Id: <20201003025424.199291-6-ehabkost@redhat.com>
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
---
include/qom/object.h | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/include/qom/object.h b/include/qom/object.h
index de121d8d8e8..e80092f349a 100644
--- a/include/qom/object.h
+++ b/include/qom/object.h
@@ -1256,7 +1256,7 @@ char *object_property_get_str(Object *obj, const char *name,
* Writes an object's canonical path to a property.
*
* If the link property was created with
- * <code>OBJ_PROP_LINK_STRONG</code> bit, the old target object is
+ * %OBJ_PROP_LINK_STRONG bit, the old target object is
* unreferenced, and a reference is added to the new target object.
*
* Returns: %true on success, %false on failure.
@@ -1603,16 +1603,16 @@ void object_property_allow_set_link(const Object *obj, const char *name,
*
* Links form the graph in the object model.
*
- * The <code>@check()</code> callback is invoked when
+ * The @check() callback is invoked when
* object_property_set_link() is called and can raise an error to prevent the
- * link being set. If <code>@check</code> is NULL, the property is read-only
+ * link being set. If @check is NULL, the property is read-only
* and cannot be set.
*
* Ownership of the pointer that @child points to is transferred to the
- * link property. The reference count for <code>*@child</code> is
+ * link property. The reference count for *@child is
* managed by the property from after the function returns till the
* property is deleted with object_property_del(). If the
- * <code>@flags</code> <code>OBJ_PROP_LINK_STRONG</code> bit is set,
+ * @flags %OBJ_PROP_LINK_STRONG bit is set,
* the reference count is decremented when the property is deleted or
* modified.
*
@@ -1823,7 +1823,7 @@ ObjectProperty *object_class_property_add_uint64_ptr(ObjectClass *klass,
* Add an alias for a property on an object. This function will add a property
* of the same type as the forwarded property.
*
- * The caller must ensure that <code>@target_obj</code> stays alive as long as
+ * The caller must ensure that @target_obj stays alive as long as
* this property exists. In the case of a child object or an alias on the same
* object this will be the case. For aliases to other objects the caller is
* responsible for taking a reference.
--
2.26.2
next prev parent reply other threads:[~2020-10-05 21:25 UTC|newest]
Thread overview: 36+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-05 21:09 [PULL 00/21] machine + QOM queue, 2020-10-05 Eduardo Habkost
2020-10-05 21:09 ` [PULL 01/21] numa: hmat: require parent cache description before the next level one Eduardo Habkost
2020-10-05 21:09 ` [PULL 02/21] hw/core/qdev-properties: Use qemu_strtol() in set_mac() handler Eduardo Habkost
2020-10-05 21:09 ` [PULL 03/21] hw/core/qdev-properties: Use qemu_strtoul() in set_pci_host_devaddr() Eduardo Habkost
2020-10-05 21:09 ` [PULL 04/21] hw/core/qdev-properties: Fix code style Eduardo Habkost
2020-10-05 21:09 ` [PULL 05/21] hw/core/qdev-properties: Export enum-related functions Eduardo Habkost
2020-10-05 21:09 ` [PULL 06/21] hw/core/qdev-properties: Export qdev_prop_enum Eduardo Habkost
2020-10-05 21:09 ` [PULL 07/21] hw/core/qdev-properties: Export some integer-related functions Eduardo Habkost
2020-10-05 21:09 ` [PULL 08/21] hw/core/qdev-properties: Extract system-mode specific properties Eduardo Habkost
2020-10-05 21:09 ` [PULL 09/21] hw/core/cpu: Add missing 'exec/cpu-common.h' include Eduardo Habkost
2020-10-05 21:09 ` [PULL 10/21] qom: Improve error message displayed with missing object properties Eduardo Habkost
2020-10-05 21:09 ` [PULL 11/21] qom: Fix DECLARE_*CHECKER documentation Eduardo Habkost
2020-10-05 21:09 ` [PULL 12/21] docs/devel/qom: Fix indentation of bulleted list Eduardo Habkost
2020-10-05 21:09 ` [PULL 13/21] docs/devel/qom: Fix indentation of code blocks Eduardo Habkost
2020-10-05 21:09 ` [PULL 14/21] docs/devel/qom: Use *emphasis* for emphasis Eduardo Habkost
2020-10-05 21:09 ` Eduardo Habkost [this message]
2020-10-05 21:09 ` [PULL 16/21] docs/devel/qom: Avoid long lines Eduardo Habkost
2020-10-05 21:09 ` [PULL 17/21] kernel-doc: Handle function typedefs that return pointers Eduardo Habkost
2020-10-05 21:09 ` [PULL 18/21] kernel-doc: Handle function typedefs without asterisks Eduardo Habkost
2020-10-05 21:09 ` [PULL 19/21] qom: Explicitly tag doc comments for typedefs and structs Eduardo Habkost
2020-10-05 21:09 ` [PULL 20/21] memory: Explicitly tag doc comments for structs Eduardo Habkost
2020-10-05 21:10 ` [PULL 21/21] kernel-doc: Remove $decl_type='type name' hack Eduardo Habkost
2020-10-06 14:03 ` [PULL 00/21] machine + QOM queue, 2020-10-05 Peter Maydell
2020-10-06 14:36 ` Eduardo Habkost
2020-10-06 14:38 ` Peter Maydell
2020-10-06 14:42 ` Daniel P. Berrangé
2020-10-06 18:47 ` Thomas Huth
2020-10-06 19:10 ` Paolo Bonzini
2020-10-07 9:10 ` Daniel P. Berrangé
2020-10-07 8:17 ` Daniel P. Berrangé
2020-10-06 14:41 ` Paolo Bonzini
2020-10-06 15:04 ` Igor Mammedov
2020-10-06 15:23 ` Igor Mammedov
2020-10-06 15:42 ` Paolo Bonzini
2020-10-06 16:14 ` Igor Mammedov
2020-10-06 18:43 ` Thomas Huth
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=20201005211000.710404-16-ehabkost@redhat.com \
--to=ehabkost@redhat.com \
--cc=berrange@redhat.com \
--cc=pbonzini@redhat.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).