starred/qemu-qemu-1
1
0
Fork 0
mirror of https://github.com/qemu/qemu.git synced 2026-07-08 17:56:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge tag 'pbouvier/pr/docs-20260522' of https://gitlab.com/p-b-o/qemu into staging

Browse Source 
Changes:
- [PATCH] docs/code-provenance: Fix formatting of *-by tags (=?utf-8?q?J=2E_Neusch=C3=A4fer?= <j.neuschaefer@9elements.com>)
  Link: https://lore.kernel.org/qemu-devel/20260520-prov-v1-1-7a58af334b9c@9elements.com
- [PATCH] docs/devel/qom: Fix some editing errors (=?utf-8?q?J=2E_Neusch=C3=A4fer?= <j.neuschaefer@9elements.com>)
  Link: https://lore.kernel.org/qemu-devel/20260520-qom-v1-1-baad87fefe4f@9elements.com
- [PATCH] docs/devel: Fix typo (s/exist paths/exit paths/) (=?utf-8?q?J=2E_Neusch=C3=A4fer?= <j.neuschaefer@9elements.com>)
  Link: https://lore.kernel.org/qemu-devel/20260520-exist-v1-1-535f929a87ae@9elements.com

# -----BEGIN PGP SIGNATURE-----
#
# iQGzBAABCgAdFiEEN8FWlNi6l2Sxlz/btEQ30ZwoYt8FAmoQpgYACgkQtEQ30Zwo
# Yt/58wwAqfxoN1Smg7Y7bEd5OuVxP8zFlL2KBFKR27N2df4VSFJl1fTnAKXgaaNj
# dm1RB6xLGmfyukXsy7ZZ7syVdsu5VjLtzoZMSt9IgIZ2KVfUMryuWkW9qcXqtiMe
# pFO4sxII1lTbY3rt7jJWvdeN0SY9jVnh0PwZOCaq68yMuAF3kDG4wHWfWmo7EqAw
# PmGrBLTS9CyKQDTK6S2UnOTtYSnhYfTdLDUvDo2dkxR0G91hHn0WcQPPuT0I4VaO
# Ft2Kav5lxHs/Q6NjSwfEflfkGrAm3jwoVSEZwMJyrirRpWOgcUfz0t3E7mMiRRuc
# fhI+qkwcIvFi7FiODMVByJ/MOvs+vpQnXOLze4oeVMrU7NVGF3H5uvJpAVlVy4gX
# BNuRG8FO8Epa+66DLlQAHcyNXt5/zemcvfkNLTSHFSOijbtTAan7VYuKY31fco25
# +i+Xq8nXX8Lr77Qs1aYxXCWV+ZwOAxmFWnIlfwNXkgr1iRKOlYvWmZoh0fAIax9P
# Vjsq0Hew
# =M9D4
# -----END PGP SIGNATURE-----
# gpg: Signature made Fri 22 May 2026 14:52:54 EDT
# gpg:                using RSA key 37C15694D8BA9764B1973FDBB44437D19C2862DF
# gpg: Good signature from "Pierrick Bouvier <pierrick.bouvier@oss.qualcomm.com>" [unknown]
# gpg: WARNING: This key is not certified with a trusted signature!
# gpg:          There is no indication that the signature belongs to the owner.
# Primary key fingerprint: 37C1 5694 D8BA 9764 B197  3FDB B444 37D1 9C28 62DF

* tag 'pbouvier/pr/docs-20260522' of https://gitlab.com/p-b-o/qemu:
  docs/devel: Fix typo (s/exist paths/exit paths/)
  docs/devel/qom: Fix some editing errors
  docs/code-provenance: Fix formatting of *-by tags

Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
This commit is contained in:
Stefan Hajnoczi
2026-05-24 07:45:19 -04:00
parent db34a713c3 6a570c504f
commit cbf877d67a
3 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/devel/code-provenance.rst
View File

@@ -99,13 +99,13 @@ Other commit tags
While the ``Signed-off-by`` tag is mandatory, there are a number of other tags
that are commonly used during QEMU development:
* **``Reviewed-by``**: when a QEMU community member reviews a patch on the
* **Reviewed-by**: when a QEMU community member reviews a patch on the
mailing list, if they consider the patch acceptable, they should send an
email reply containing a ``Reviewed-by`` tag. Subsystem maintainers who
review a patch should add this even if they are also adding their
``Signed-off-by`` to the same commit.
* **``Acked-by``**: when a QEMU subsystem maintainer approves a patch that
* **Acked-by**: when a QEMU subsystem maintainer approves a patch that
touches their subsystem, but intends to allow a different maintainer to
queue it and send a pull request, they would send a mail containing a
``Acked-by`` tag. Where a patch touches multiple subsystems, ``Acked-by``
@@ -113,18 +113,18 @@ that are commonly used during QEMU development:
maintainer wants to indicate they have done a full review they should use
a ``Reviewed-by`` tag.
* **``Tested-by``**: when a QEMU community member has functionally tested the
* **Tested-by**: when a QEMU community member has functionally tested the
behaviour of the patch in some manner, they should send an email reply
containing a ``Tested-by`` tag.
* **``Reported-by``**: when a QEMU community member reports a problem via the
* **Reported-by**: when a QEMU community member reports a problem via the
mailing list, or some other informal channel that is not the issue tracker,
it is good practice to credit them by including a ``Reported-by`` tag on
any patch fixing the issue. When the problem is reported via the GitLab
issue tracker, however, it is sufficient to just include a link to the
issue.
* **``Suggested-by``**: when a reviewer or other 3rd party makes non-trivial
* **Suggested-by**: when a reviewer or other 3rd party makes non-trivial
suggestions for how to change a patch, it is good practice to credit them
by including a ``Suggested-by`` tag.

4
docs/devel/qom.rst
View File

@@ -435,14 +435,14 @@ OBJECT_DEFINE_ABSTRACT_TYPE() macro can be used instead:
Device Life-cycle
=================
As class initialisation cannot fail devices have an two additional
As class initialisation cannot fail, devices have two additional
methods to handle the creation of dynamic devices. The ``realize``
function is called with ``Error **`` pointer which should be set if
the device cannot complete its setup. Otherwise on successful
completion of the ``realize`` method the device object is added to the
QOM tree and made visible to the guest.
The reverse function is ``unrealize`` and should be were clean-up
The reverse function is ``unrealize`` and should be where clean-up
code lives to tidy up after the system is done with the device.
All devices can be instantiated by C code, however only some can

2
docs/devel/style.rst
View File

@@ -469,7 +469,7 @@ for a time/space trade-off like ``tlb_mmu_resize_locked`` in the
SoftMMU TLB code.
If the lifetime of the allocation is within the function and there are
multiple exist paths you can also improve the readability of the code
multiple exit paths you can also improve the readability of the code
by using ``g_autofree`` and related annotations. See :ref:`autofree-ref`
for more details.