From nobody Mon May 12 13:51:28 2025
Delivered-To: importer@patchew.org
Authentication-Results: mx.zohomail.com;
dkim=pass;
spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as
permitted sender)
smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org;
dmarc=pass(p=none dis=none) header.from=linaro.org
ARC-Seal: i=1; a=rsa-sha256; t=1733513424; cv=none;
d=zohomail.com; s=zohoarc;
b=XGUjNT3IVCdVkUzX8mkwtuTvmvmLTgd7ixz6UyBj8MGIwiIod8GltDzre9r8L0No6AJwaJH/7W/x3EDzPd7H3BIjjPl9f+hTiKIGgKR2h8i58Vl7h0xbEWLrZvIg8WwyewOu+EmTwtDg1xKpyo+ivaYE7DDEq7fh9vcovU7X95U=
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com;
s=zohoarc;
t=1733513424;
h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To;
bh=FbPMtxcOc3D4j1V0HPSTBCu31VLQo3b2yamOLZCop3s=;
b=QNJs08/8Ftq/THnUQTz2HKUR0n2lEx0x6s/jdiC9tMKMF9YfOBsPZDvlBJi8vnJDSUjuGEU6reQ9nyHyHkinp453XSm5gQgMRhGqS7fvlGxZ6VzHUxbvvMlbuj14AgbenNtn40gKdMm808Qh81p30vWTZM2ESaWZ0V0Ys+uAS6Q=
ARC-Authentication-Results: i=1; mx.zohomail.com;
dkim=pass;
spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as
permitted sender)
smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org;
dmarc=pass header.from=<pierrick.bouvier@linaro.org> (p=none dis=none)
Return-Path: <qemu-devel-bounces+importer=patchew.org@nongnu.org>
Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by
mx.zohomail.com
with SMTPS id 1733513423490535.7656299535431;
Fri, 6 Dec 2024 11:30:23 -0800 (PST)
Received: from localhost ([::1] helo=lists1p.gnu.org)
by lists.gnu.org with esmtp (Exim 4.90_1)
(envelope-from <qemu-devel-bounces@nongnu.org>)
id 1tJe0s-0002rE-HB; Fri, 06 Dec 2024 14:29:19 -0500
Received: from eggs.gnu.org ([2001:470:142:3::10])
by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
(Exim 4.90_1) (envelope-from <pierrick.bouvier@linaro.org>)
id 1tJe0o-0002qC-Ga
for qemu-devel@nongnu.org; Fri, 06 Dec 2024 14:29:15 -0500
Received: from mail-pl1-x62b.google.com ([2607:f8b0:4864:20::62b])
by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128)
(Exim 4.90_1) (envelope-from <pierrick.bouvier@linaro.org>)
id 1tJe0l-0005Er-4C
for qemu-devel@nongnu.org; Fri, 06 Dec 2024 14:29:14 -0500
Received: by mail-pl1-x62b.google.com with SMTP id
d9443c01a7336-215936688aeso23083905ad.1
for <qemu-devel@nongnu.org>; Fri, 06 Dec 2024 11:29:10 -0800 (PST)
Received: from pc.. (216-180-64-156.dyn.novuscom.net. [216.180.64.156])
by smtp.gmail.com with ESMTPSA id
d9443c01a7336-215f8ef9fcdsm32110205ad.146.2024.12.06.11.29.08
(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
Fri, 06 Dec 2024 11:29:09 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=linaro.org; s=google; t=1733513349; x=1734118149; darn=nongnu.org;
h=content-transfer-encoding:mime-version:references:in-reply-to
:message-id:date:subject:cc:to:from:from:to:cc:subject:date
:message-id:reply-to;
bh=FbPMtxcOc3D4j1V0HPSTBCu31VLQo3b2yamOLZCop3s=;
b=kk9dqz92d10YhMsOAwNKxNBem65lLBXIqXL17qAZohuEOKzdU89MvCUaVsZd/1uvVG
xRveCFpaurl99Q+rpTW6I1cI24xLGZ7tYcnl6NeAA5+fBQZkHhXpzTBZgnALshaCx1+C
8qL7gJ0/6I7x5Lpvih592jqZiZFfw3+p7Ej0AZAS05f1q4wxTAvRRUdd6ck8KednccPT
Sdfd3cBL5vEdqgwX2+U1v5Kq34kxSAbrb6kTgGp8T4TMObpGBUvCH/H2NmPq+TNIdye4
llIDKNgAj+JhXT1h9+kgO1m10gI3iBl+Jbyl7DKmNIC1qb080d5m1eaxRlAlGasbmU52
OAJg==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20230601; t=1733513349; x=1734118149;
h=content-transfer-encoding:mime-version:references:in-reply-to
:message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc
:subject:date:message-id:reply-to;
bh=FbPMtxcOc3D4j1V0HPSTBCu31VLQo3b2yamOLZCop3s=;
b=UUz7F++tJQEm8cWBTeWiAMO50Rfb4OaRHlPVVMRAl/mD7Fl9yL6jY8QMkXgOTwfG3+
Zy10wVyaP3+KF0DMOLdtM12sNgTqyZr7ndjkrVWXpHMiI1qWmRlWV8V9khmYg9zIXxta
HlbmWVRaKUUV15p560+LXMGuauYyVzXbotYoe6LUpDbAhi2zM1ctWgulSqK+/PshqLrP
bA229Qa8OxsuJunhDePZLlh1t6OzwqdZ/UqXpF1OOICMLY1fEXXul07N6/FVMhKtI6aR
TtaUPFYsO/s7DC9qW8jowa6GEuYkckfzlxNvSHqTLqpFyVC9ueda6oAowgsM+GLGdO72
5WrA==
X-Gm-Message-State: AOJu0Yz4o+MODd8+ZX6ZpLHDZKXbYikANeJ4vBjsdx/lOyPiI3mDfKXP
Fk8MbfziQezJerWozHsS6zqaid059iI1x/1NxmSpuL4alIXEuXizatEsL9cuSR7/NymikRzPGwc
fLzE=
X-Gm-Gg: ASbGnctaJVJ48d8n4bjYFJsdDRbwB2c8QahAj0vUU686F0RNySpX7HIC9Q4WbFnJVHP
ROKQgee9M73UuuvPwCB6iqr7hQhXexWKerYyot5Nm937OuWBpjZkTldlQgQym0Gw/Rn+mC3aHVq
OYTt1Q5DUXqhMLVCBgHAvsstfpooIx+yKLaaJ5xJtLPUVciIK4OivHt4GasUu+/vK5Os7ei/UxX
JGVNmPebt1GzzPAr++J5tcLLMH1eTXL8xwVSWaBfiS2Lk2WMi5ZYL9BlWuLSe/ilv8bftqbgLsc
Id6WSpIh
X-Google-Smtp-Source:
AGHT+IFMrlZJVSch9+XLcwCmnYK958N0MU6X3npy9db4D7XTYUqGyFCj6Ns4sOuLUYXsJ3CdST3c6g==
X-Received: by 2002:a17:903:2348:b0:212:996:3559 with SMTP id
d9443c01a7336-21614d2e567mr62280495ad.5.1733513349592;
Fri, 06 Dec 2024 11:29:09 -0800 (PST)
From: Pierrick Bouvier <pierrick.bouvier@linaro.org>
To: qemu-devel@nongnu.org
Cc: Peter Maydell <peter.maydell@linaro.org>,
=?UTF-8?q?Alex=20Benn=C3=A9e?= <alex.bennee@linaro.org>,
Richard Henderson <richard.henderson@linaro.org>, qemu-block@nongnu.org,
philmd@linaro.org, Paolo Bonzini <pbonzini@redhat.com>,
Fabiano Rosas <farosas@suse.de>,
Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>,
=?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= <berrange@redhat.com>,
Markus Armbruster <armbru@redhat.com>, qemu-arm@nongnu.org,
Michael Roth <michael.roth@amd.com>, Peter Xu <peterx@redhat.com>,
gustavo.romero@linaro.org, Yuri Benditovich <yuri.benditovich@daynix.com>,
Eric Blake <eblake@redhat.com>, Andrew Melnychenko <andrew@daynix.com>,
Konstantin Kostiuk <kkostiuk@redhat.com>, Kevin Wolf <kwolf@redhat.com>,
Thomas Huth <thuth@redhat.com>, Jason Wang <jasowang@redhat.com>,
manos.pitsidianakis@linaro.org,
Pierrick Bouvier <pierrick.bouvier@linaro.org>
Subject: [PATCH v3 1/6] docs/devel: remove dead video link for sourcehut
submit process
Date: Fri, 6 Dec 2024 11:28:55 -0800
Message-Id: <20241206192900.3893118-2-pierrick.bouvier@linaro.org>
X-Mailer: git-send-email 2.39.5
In-Reply-To: <20241206192900.3893118-1-pierrick.bouvier@linaro.org>
References: <20241206192900.3893118-1-pierrick.bouvier@linaro.org>
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17
as permitted sender) client-ip=209.51.188.17;
envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org;
helo=lists.gnu.org;
Received-SPF: pass client-ip=2607:f8b0:4864:20::62b;
envelope-from=pierrick.bouvier@linaro.org; helo=mail-pl1-x62b.google.com
X-Spam_score_int: -20
X-Spam_score: -2.1
X-Spam_bar: --
X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1,
DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1,
RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001,
SPF_PASS=-0.001 autolearn=ham autolearn_force=no
X-Spam_action: no action
X-BeenThere: qemu-devel@nongnu.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: <qemu-devel.nongnu.org>
List-Unsubscribe: <https://lists.nongnu.org/mailman/options/qemu-devel>,
<mailto:qemu-devel-request@nongnu.org?subject=unsubscribe>
List-Archive: <https://lists.nongnu.org/archive/html/qemu-devel>
List-Post: <mailto:qemu-devel@nongnu.org>
List-Help: <mailto:qemu-devel-request@nongnu.org?subject=help>
List-Subscribe: <https://lists.nongnu.org/mailman/listinfo/qemu-devel>,
<mailto:qemu-devel-request@nongnu.org?subject=subscribe>
Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org
Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org
X-ZohoMail-DKIM: pass (identity @linaro.org)
X-ZM-MESSAGEID: 1733513426250116600
Content-Type: text/plain; charset="utf-8"
Reviewed-by: Thomas Huth <thuth@redhat.com>
Signed-off-by: Pierrick Bouvier <pierrick.bouvier@linaro.org>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
---
docs/devel/submitting-a-patch.rst | 5 +----
1 file changed, 1 insertion(+), 4 deletions(-)
diff --git a/docs/devel/submitting-a-patch.rst b/docs/devel/submitting-a-pa=
tch.rst
index 10b062eec26..03b2ac298aa 100644
--- a/docs/devel/submitting-a-patch.rst
+++ b/docs/devel/submitting-a-patch.rst
@@ -252,10 +252,7 @@ patches to the QEMU mailing list by following these st=
eps:
#. Send your patches to the QEMU mailing list using the web-based
``git-send-email`` UI at https://git.sr.ht/~USERNAME/qemu/send-email
=20
-`This video
-<https://spacepub.space/videos/watch/ad258d23-0ac6-488c-83fc-2bacf578de3a>=
`__
-shows the web-based ``git-send-email`` workflow. Documentation is
-available `here
+Documentation for sourcehut is available `here
<https://man.sr.ht/git.sr.ht/#sending-patches-upstream>`__.
=20
.. _cc_the_relevant_maintainer:
--=20
2.39.5
From nobody Mon May 12 13:51:28 2025
Delivered-To: importer@patchew.org
Authentication-Results: mx.zohomail.com;
dkim=pass;
spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as
permitted sender)
smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org;
dmarc=pass(p=none dis=none) header.from=linaro.org
ARC-Seal: i=1; a=rsa-sha256; t=1733513450; cv=none;
d=zohomail.com; s=zohoarc;
b=GzXrsXlxM9T4dGeOoEdJvDXYrHFSDS79CL4DcdwkY/i1zEZYPiBiJEm9xmxBc/1be/30fI9nb3Zumon6XuHVjOaM5WDmpKQXw1KWTh2XbnyZh4+0HPZ4MM8F62O+3zSe2sevf2UESPspeRbZJBEX2gk/sFBM4CsfJKkWNKBUosw=
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com;
s=zohoarc;
t=1733513450;
h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To;
bh=YhN5xzTKOMEr8P5uJC22JY6ORCTpZxAfyG3HnT0ezPQ=;
b=H/qz9rETiXPyx3DFqxDsy1R3q2f82uQCb5E6NitSyDOV4zIdz7c0hELHrvp7fhBsG0fTSryg9+aPF1+LMGRm5Y/ldt/15ZlBUmhgzMrw0HMY5WMmb5cKhXcjMKWb0kJVqvusYv+XJC/EsXGvJC7Kno1VJJ7+ds3sTifHezHr9jU=
ARC-Authentication-Results: i=1; mx.zohomail.com;
dkim=pass;
spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as
permitted sender)
smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org;
dmarc=pass header.from=<pierrick.bouvier@linaro.org> (p=none dis=none)
Return-Path: <qemu-devel-bounces+importer=patchew.org@nongnu.org>
Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by
mx.zohomail.com
with SMTPS id 1733513450240826.8958171917792;
Fri, 6 Dec 2024 11:30:50 -0800 (PST)
Received: from localhost ([::1] helo=lists1p.gnu.org)
by lists.gnu.org with esmtp (Exim 4.90_1)
(envelope-from <qemu-devel-bounces@nongnu.org>)
id 1tJe1Z-0003EN-5p; Fri, 06 Dec 2024 14:30:01 -0500
Received: from eggs.gnu.org ([2001:470:142:3::10])
by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
(Exim 4.90_1) (envelope-from <pierrick.bouvier@linaro.org>)
id 1tJe0t-0002rk-RL
for qemu-devel@nongnu.org; Fri, 06 Dec 2024 14:29:21 -0500
Received: from mail-pl1-x62f.google.com ([2607:f8b0:4864:20::62f])
by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128)
(Exim 4.90_1) (envelope-from <pierrick.bouvier@linaro.org>)
id 1tJe0p-0005Fh-QV
for qemu-devel@nongnu.org; Fri, 06 Dec 2024 14:29:18 -0500
Received: by mail-pl1-x62f.google.com with SMTP id
d9443c01a7336-216281bc30fso2734955ad.0
for <qemu-devel@nongnu.org>; Fri, 06 Dec 2024 11:29:13 -0800 (PST)
Received: from pc.. (216-180-64-156.dyn.novuscom.net. [216.180.64.156])
by smtp.gmail.com with ESMTPSA id
d9443c01a7336-215f8ef9fcdsm32110205ad.146.2024.12.06.11.29.09
(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
Fri, 06 Dec 2024 11:29:10 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=linaro.org; s=google; t=1733513352; x=1734118152; darn=nongnu.org;
h=content-transfer-encoding:mime-version:references:in-reply-to
:message-id:date:subject:cc:to:from:from:to:cc:subject:date
:message-id:reply-to;
bh=YhN5xzTKOMEr8P5uJC22JY6ORCTpZxAfyG3HnT0ezPQ=;
b=OIr98HjuIHsRG6TIwssn1A8MkVhJJ57zupvowlb9/rpn83KGED9zhMFJ2VRG7DTtD0
Nf0aa3UCoksLN5RwNSFcykmOtkHL3VwGvWSkRKM7TTLlFj/Pd6gOmu7dCLw3SkL6lDID
UmJkRoBnEr8984zkeksZD1E+A6ttq2UW6aEhvbsbWKHFvYKNVhpK9znxpgrtB/8auNBo
QnyvZ0cdpsSu3po07gQFcpF8enjxv3Ak/57j2AaodatwuydO8kodtINm70QVlJCu5Clo
C5t++6PsnWITQ2OcqXhMx6Mni1x/rZBbsuL7cmO2SOTKmWqjyYEzO5D095IMOVTGOeWS
8j8Q==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20230601; t=1733513352; x=1734118152;
h=content-transfer-encoding:mime-version:references:in-reply-to
:message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc
:subject:date:message-id:reply-to;
bh=YhN5xzTKOMEr8P5uJC22JY6ORCTpZxAfyG3HnT0ezPQ=;
b=rnumVOnYfEynRn02P5+KpvStRp2PeBY+WbHiWFBpS/xFT2clgnet9C0oDELMoSY1Kv
/la4D6ElpsgQFbX95kknK/8xgw24+j7Uw1jta4jy+DOFA8MmAKtJRxpacE6ruVCTyjlx
Yn4bA4id4tz0Jp6pWCNrmF7nKV3FLkbGmRHmDpCLUItIQIYRDZopsF0kJR6tDGNbFnIn
w1/jeaF3A0llvvQN8l9KFWbyQbc3hfzazsVabPWEENtHxH8PVHXl0YFQwZQb5lNi/9ud
TxezmYztxTWNSQ2oQiH+Azv+Y2MXDCiBbtgNICoevjDyQ8yODKFWkym4oXQ7Cb0dLEFt
E8Fg==
X-Gm-Message-State: AOJu0YwzfQVNS1VCaR5QcMMv/wBIEbQXv5mDxv/w7okHPx5WG7aAejFo
mCv1dGldrW8XWkyjxjFnpuu8lSzDkszfsU4zu8lMZXrNRn8NOgQbpI0PQejhX1SYoBO3w2xsLCH
FKD0=
X-Gm-Gg: ASbGncvPo3GNbn11+NsndXPhgmYgvzenMKIPcBK3IWzMMedS8adLNOJkxqiIWIMUAn8
rMq5rYZIRC8leyYBuqsYh7bNr1ln8cj4vMqOERc0hEOwvJdlPY+Q3CEXIEG/d6fiUqTeh68upfv
nofhl6N5iBgLG9HHdpZqwH1nkXp093yTuNVYt3iXG9z7ulOWwFu7lCrvsbt/DV63UjH8OM5+/DF
bnVthr5fx5zyQKS5O5vK0F0zLlaTkqfcDsuzTVD/jCkznjbtRRUrTks9uOSyCwGZUy2lhULf91B
qN6PmK07
X-Google-Smtp-Source:
AGHT+IFDwS8hBE+y3jFfJJEZi4eQD0EEfUJjjDqdu9yebhzu6uqlKD0UZCl7qr1eNOsm3r3/DSXGCA==
X-Received: by 2002:a17:902:c405:b0:215:a3fb:b4d6 with SMTP id
d9443c01a7336-21614d54353mr61890765ad.8.1733513350722;
Fri, 06 Dec 2024 11:29:10 -0800 (PST)
From: Pierrick Bouvier <pierrick.bouvier@linaro.org>
To: qemu-devel@nongnu.org
Cc: Peter Maydell <peter.maydell@linaro.org>,
=?UTF-8?q?Alex=20Benn=C3=A9e?= <alex.bennee@linaro.org>,
Richard Henderson <richard.henderson@linaro.org>, qemu-block@nongnu.org,
philmd@linaro.org, Paolo Bonzini <pbonzini@redhat.com>,
Fabiano Rosas <farosas@suse.de>,
Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>,
=?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= <berrange@redhat.com>,
Markus Armbruster <armbru@redhat.com>, qemu-arm@nongnu.org,
Michael Roth <michael.roth@amd.com>, Peter Xu <peterx@redhat.com>,
gustavo.romero@linaro.org, Yuri Benditovich <yuri.benditovich@daynix.com>,
Eric Blake <eblake@redhat.com>, Andrew Melnychenko <andrew@daynix.com>,
Konstantin Kostiuk <kkostiuk@redhat.com>, Kevin Wolf <kwolf@redhat.com>,
Thomas Huth <thuth@redhat.com>, Jason Wang <jasowang@redhat.com>,
manos.pitsidianakis@linaro.org,
Pierrick Bouvier <pierrick.bouvier@linaro.org>
Subject: [PATCH v3 2/6] docs/devel: add git-publish for patch submitting
Date: Fri, 6 Dec 2024 11:28:56 -0800
Message-Id: <20241206192900.3893118-3-pierrick.bouvier@linaro.org>
X-Mailer: git-send-email 2.39.5
In-Reply-To: <20241206192900.3893118-1-pierrick.bouvier@linaro.org>
References: <20241206192900.3893118-1-pierrick.bouvier@linaro.org>
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17
as permitted sender) client-ip=209.51.188.17;
envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org;
helo=lists.gnu.org;
Received-SPF: pass client-ip=2607:f8b0:4864:20::62f;
envelope-from=pierrick.bouvier@linaro.org; helo=mail-pl1-x62f.google.com
X-Spam_score_int: -20
X-Spam_score: -2.1
X-Spam_bar: --
X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1,
DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1,
RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001,
SPF_PASS=-0.001 autolearn=ham autolearn_force=no
X-Spam_action: no action
X-BeenThere: qemu-devel@nongnu.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: <qemu-devel.nongnu.org>
List-Unsubscribe: <https://lists.nongnu.org/mailman/options/qemu-devel>,
<mailto:qemu-devel-request@nongnu.org?subject=unsubscribe>
List-Archive: <https://lists.nongnu.org/archive/html/qemu-devel>
List-Post: <mailto:qemu-devel@nongnu.org>
List-Help: <mailto:qemu-devel-request@nongnu.org?subject=help>
List-Subscribe: <https://lists.nongnu.org/mailman/listinfo/qemu-devel>,
<mailto:qemu-devel-request@nongnu.org?subject=subscribe>
Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org
Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org
X-ZohoMail-DKIM: pass (identity @linaro.org)
X-ZM-MESSAGEID: 1733513452061116600
Content-Type: text/plain; charset="utf-8"
Signed-off-by: Pierrick Bouvier <pierrick.bouvier@linaro.org>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
---
docs/devel/submitting-a-patch.rst | 25 +++++++++++++++++++++++++
1 file changed, 25 insertions(+)
diff --git a/docs/devel/submitting-a-patch.rst b/docs/devel/submitting-a-pa=
tch.rst
index 03b2ac298aa..69df7682c5e 100644
--- a/docs/devel/submitting-a-patch.rst
+++ b/docs/devel/submitting-a-patch.rst
@@ -235,6 +235,31 @@ to another list.) ``git send-email`` (`step-by-step se=
tup guide
works best for delivering the patch without mangling it, but
attachments can be used as a last resort on a first-time submission.
=20
+.. _use_git_publish:
+
+Use git-publish
+~~~~~~~~~~~~~~~
+
+If you already configured git send-email, you can simply use `git-publish
+<https://github.com/stefanha/git-publish>`__ to send series.
+
+::
+
+ $ git checkout master -b my-feature
+ $ # work on new commits, add your 'Signed-off-by' lines to each
+ $ git publish
+ $ ... more work, rebase on master, ...
+ $ git publish # will send a v2
+
+Each time you post a series, git-publish will create a local tag with the =
format
+``<branchname>-v<version>`` to record the patch series.
+
+When sending patch emails, 'git publish' will consult the output of
+'scripts/get_maintainers.pl' and automatically CC anyone listed as maintai=
ners
+of the affected code. Generally you should accept the suggested CC list, b=
ut
+there may sometimes be scenarios where it is appropriate to cut it down (e=
g on
+certain large tree-wide cleanups), or augment it with other interested peo=
ple.
+
.. _if_you_cannot_send_patch_emails:
=20
If you cannot send patch emails
--=20
2.39.5
From nobody Mon May 12 13:51:28 2025
Delivered-To: importer@patchew.org
Authentication-Results: mx.zohomail.com;
dkim=pass;
spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as
permitted sender)
smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org;
dmarc=pass(p=none dis=none) header.from=linaro.org
ARC-Seal: i=1; a=rsa-sha256; t=1733513431; cv=none;
d=zohomail.com; s=zohoarc;
b=bQXldVjieZ+MEEi4f75bhunDZhtOLxKISE/rK6BCUdMKZZxH9AnC8OH8tH9WpKprXZihGbMf2ziY2Z6DfFmReAEKrHWBTYSOZA3VqoE8atJ9VRC0qxy89523nT6i7Cqhq42mgy0ayCkSatrmBkPHXfgEFKQgisASbsxMkeX1tTw=
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com;
s=zohoarc;
t=1733513431;
h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To;
bh=97w0wPWp6SUzaCB1TOeEg95vGLLrte4OzIrt9h4+KrY=;
b=RHln7VijWDkCeAmOGnZoaA/Twx/mm5svJykWfUIWX4KBDOJ8Ts6l7e+CuBcYNtyGNgBRZfGYV0/JljNrzPiPRENZMiFdo9Ns6ySbTsIwCAjoCPsKnbr1ec6tev/TO3YHrJQ7KRp8+N1FPJki/7SNiziNMj6L2k8IGP8V7E+Quro=
ARC-Authentication-Results: i=1; mx.zohomail.com;
dkim=pass;
spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as
permitted sender)
smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org;
dmarc=pass header.from=<pierrick.bouvier@linaro.org> (p=none dis=none)
Return-Path: <qemu-devel-bounces+importer=patchew.org@nongnu.org>
Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by
mx.zohomail.com
with SMTPS id 1733513431094918.1072368829947;
Fri, 6 Dec 2024 11:30:31 -0800 (PST)
Received: from localhost ([::1] helo=lists1p.gnu.org)
by lists.gnu.org with esmtp (Exim 4.90_1)
(envelope-from <qemu-devel-bounces@nongnu.org>)
id 1tJe1Y-0003BP-7v; Fri, 06 Dec 2024 14:30:00 -0500
Received: from eggs.gnu.org ([2001:470:142:3::10])
by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
(Exim 4.90_1) (envelope-from <pierrick.bouvier@linaro.org>)
id 1tJe0s-0002rT-LW
for qemu-devel@nongnu.org; Fri, 06 Dec 2024 14:29:19 -0500
Received: from mail-pl1-x631.google.com ([2607:f8b0:4864:20::631])
by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128)
(Exim 4.90_1) (envelope-from <pierrick.bouvier@linaro.org>)
id 1tJe0o-0005FX-9H
for qemu-devel@nongnu.org; Fri, 06 Dec 2024 14:29:18 -0500
Received: by mail-pl1-x631.google.com with SMTP id
d9443c01a7336-215936688aeso23084185ad.1
for <qemu-devel@nongnu.org>; Fri, 06 Dec 2024 11:29:13 -0800 (PST)
Received: from pc.. (216-180-64-156.dyn.novuscom.net. [216.180.64.156])
by smtp.gmail.com with ESMTPSA id
d9443c01a7336-215f8ef9fcdsm32110205ad.146.2024.12.06.11.29.10
(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
Fri, 06 Dec 2024 11:29:11 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=linaro.org; s=google; t=1733513352; x=1734118152; darn=nongnu.org;
h=content-transfer-encoding:mime-version:references:in-reply-to
:message-id:date:subject:cc:to:from:from:to:cc:subject:date
:message-id:reply-to;
bh=97w0wPWp6SUzaCB1TOeEg95vGLLrte4OzIrt9h4+KrY=;
b=Z08mG0UkL4Z7bvBR4d1hmM2cnwkjkd6ZDx2U2EAAOxD+BF3pVeZecxFUKohCYWQ9UN
7Lew9Rq6AbqvoWc7qwSCEi2oW8qZ6a/sdSeVGgia/kz/krXed4Yps/cOXgfwkyvwDQex
5O00o3+7kKhrDNVRYTK+VSZ9c2UzUiNV5/bMw5c6KjaglcgemCnUgIiCSrSAe2o6xxyL
Cv1BU9zB1sw/6hP3bt3bjOOevAHT9nN06ccbQfroIW7/H4VZkXs124GREYjnYi7M9vlK
60/mo4eQ/M3pt6M5A6r/v1Ai7cKfkSFbqomjwzmBbpOws0P+CjpTg3TfYdOvy0Aeej/k
La6A==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20230601; t=1733513352; x=1734118152;
h=content-transfer-encoding:mime-version:references:in-reply-to
:message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc
:subject:date:message-id:reply-to;
bh=97w0wPWp6SUzaCB1TOeEg95vGLLrte4OzIrt9h4+KrY=;
b=KKIu1j8FE55WNb806lGGjSlllF5o526ZDrLqvRCdwVYmbEjZycuZ/wMCaYxXIh+x1j
2/CfN5VF6C817w+fV3d1nr/0gNITfyuLhenyZrpDc5sF3l04FDpw3I3A14FYcnkxCT7m
YNXpgdslvn0vbCFmECQCFDdZOYt+Sb+ALIMcF/u+tTgRq0zYXFBI3/9wVEOoGWzqGYQ7
/RknsIq74WKVgW5j5noa3wscRVPR0qhN0ZroIjlD+Lg3nLw/QON3Qyjnr2DJo9V3u3Q5
rLimWRcZ453r3AUk2CCbEb1IqE7aZUWWRNAFsYICYICHQ/E3jdvKjsGWuaFX5ELwEb/r
ARFg==
X-Gm-Message-State: AOJu0YydUIVZP6r/A4AyKpGsl6rFWH2KvR5h07jrrg61F3eex5Rv5Yef
ALY1+jLPNrZri4o2eV4ACyaVWfk4hP16MiiTQ5cey9rhlmqy2vT1fey+zVZ2fMH0/CTIYujxp60
U2nc=
X-Gm-Gg: ASbGncsyO1KDA+vseeaTfGBCGWkq324x/My1N170HspZ4aG1N/Rn+kj9aaZa2J9Jtn9
nf5tiS6BMuTAS7/z9II5zcHYzDEuZDecbaR9oEruecV9NPDLJhjx0Q8GTexX5dpA3axdCazHCIu
cBuTrF+Co1LsfZNJqcgGTtJ/xWzSzN7/fwNa3/E+nOKf/4LZJbtbSxW20zw6iAuT0p5okJBfqSm
4kHr34L9/DoCXrQ1owhlafCtSsQcN30FCabAC3q7jMwLYlb5kLh6omGcaRKkcslZjlgU9q9fE43
3Z9syRiT
X-Google-Smtp-Source:
AGHT+IHa0Y/Dxhv2xnIXn3gCj2NVW4p+ze0am4IQbPdvBV+gOCBF4RSnRzRWyYyqr8PfF/9cgWcsEw==
X-Received: by 2002:a17:903:98b:b0:215:9bce:2c98 with SMTP id
d9443c01a7336-21614dcdcc6mr58945655ad.51.1733513351854;
Fri, 06 Dec 2024 11:29:11 -0800 (PST)
From: Pierrick Bouvier <pierrick.bouvier@linaro.org>
To: qemu-devel@nongnu.org
Cc: Peter Maydell <peter.maydell@linaro.org>,
=?UTF-8?q?Alex=20Benn=C3=A9e?= <alex.bennee@linaro.org>,
Richard Henderson <richard.henderson@linaro.org>, qemu-block@nongnu.org,
philmd@linaro.org, Paolo Bonzini <pbonzini@redhat.com>,
Fabiano Rosas <farosas@suse.de>,
Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>,
=?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= <berrange@redhat.com>,
Markus Armbruster <armbru@redhat.com>, qemu-arm@nongnu.org,
Michael Roth <michael.roth@amd.com>, Peter Xu <peterx@redhat.com>,
gustavo.romero@linaro.org, Yuri Benditovich <yuri.benditovich@daynix.com>,
Eric Blake <eblake@redhat.com>, Andrew Melnychenko <andrew@daynix.com>,
Konstantin Kostiuk <kkostiuk@redhat.com>, Kevin Wolf <kwolf@redhat.com>,
Thomas Huth <thuth@redhat.com>, Jason Wang <jasowang@redhat.com>,
manos.pitsidianakis@linaro.org,
Pierrick Bouvier <pierrick.bouvier@linaro.org>
Subject: [PATCH v3 3/6] docs/devel: add b4 for patch retrieval
Date: Fri, 6 Dec 2024 11:28:57 -0800
Message-Id: <20241206192900.3893118-4-pierrick.bouvier@linaro.org>
X-Mailer: git-send-email 2.39.5
In-Reply-To: <20241206192900.3893118-1-pierrick.bouvier@linaro.org>
References: <20241206192900.3893118-1-pierrick.bouvier@linaro.org>
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17
as permitted sender) client-ip=209.51.188.17;
envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org;
helo=lists.gnu.org;
Received-SPF: pass client-ip=2607:f8b0:4864:20::631;
envelope-from=pierrick.bouvier@linaro.org; helo=mail-pl1-x631.google.com
X-Spam_score_int: -20
X-Spam_score: -2.1
X-Spam_bar: --
X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1,
DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1,
RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001,
SPF_PASS=-0.001 autolearn=unavailable autolearn_force=no
X-Spam_action: no action
X-BeenThere: qemu-devel@nongnu.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: <qemu-devel.nongnu.org>
List-Unsubscribe: <https://lists.nongnu.org/mailman/options/qemu-devel>,
<mailto:qemu-devel-request@nongnu.org?subject=unsubscribe>
List-Archive: <https://lists.nongnu.org/archive/html/qemu-devel>
List-Post: <mailto:qemu-devel@nongnu.org>
List-Help: <mailto:qemu-devel-request@nongnu.org?subject=help>
List-Subscribe: <https://lists.nongnu.org/mailman/listinfo/qemu-devel>,
<mailto:qemu-devel-request@nongnu.org?subject=subscribe>
Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org
Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org
X-ZohoMail-DKIM: pass (identity @linaro.org)
X-ZM-MESSAGEID: 1733513431808116600
Content-Type: text/plain; charset="utf-8"
Signed-off-by: Pierrick Bouvier <pierrick.bouvier@linaro.org>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
---
docs/devel/submitting-a-patch.rst | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/docs/devel/submitting-a-patch.rst b/docs/devel/submitting-a-pa=
tch.rst
index 69df7682c5e..1ef7d137320 100644
--- a/docs/devel/submitting-a-patch.rst
+++ b/docs/devel/submitting-a-patch.rst
@@ -433,6 +433,16 @@ For more details on how QEMU's stable process works, r=
efer to the
=20
.. _participating_in_code_review:
=20
+Retrieve an existing series
+---------------------------
+
+If you want to apply an existing series on top of your tree, you can simpl=
y use
+`b4 <https://github.com/mricon/b4>`__.
+
+::
+
+ b4 shazam $msg-id
+
Participating in Code Review
----------------------------
=20
--=20
2.39.5
From nobody Mon May 12 13:51:28 2025
Delivered-To: importer@patchew.org
Authentication-Results: mx.zohomail.com;
dkim=pass;
spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as
permitted sender)
smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org;
dmarc=pass(p=none dis=none) header.from=linaro.org
ARC-Seal: i=1; a=rsa-sha256; t=1733513478; cv=none;
d=zohomail.com; s=zohoarc;
b=N9DT/VjlbsrNKWwLfHttlbuRcKxo7ntFeJf0yCPe11y6jAfauATRl5hoCD3vd1VI6qEb3hrCY94TJiX4TikmHYdPqVnt+PrCPowVNO2pz8xD1952HADzbyCjF6iSmol4nAmzlFtzOiEM97EPFCf7TbadnH7wpxDE2Me58Q5hyAI=
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com;
s=zohoarc;
t=1733513478;
h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To;
bh=KcbaNjWF8lnwvj+PtEoJozlcQBiv6h5KPfhVvS5OAGE=;
b=as8wuDcVoAjJst/YWdqFqawqgFrBVQau/BiAR77Tsyk7XAzpybcGF4pbS8jxiKBpBifH3dZlXeOI/9+YptNWAAfKtm3fa9BZ03U1jmymaD/a2IngoVWw0dthgmEmV2SVGQ+V3GYDn/9m1ZuXIwSUszaupdQ8h1I/IPKH/9atf18=
ARC-Authentication-Results: i=1; mx.zohomail.com;
dkim=pass;
spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as
permitted sender)
smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org;
dmarc=pass header.from=<pierrick.bouvier@linaro.org> (p=none dis=none)
Return-Path: <qemu-devel-bounces+importer=patchew.org@nongnu.org>
Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by
mx.zohomail.com
with SMTPS id 1733513478289829.8093731939073;
Fri, 6 Dec 2024 11:31:18 -0800 (PST)
Received: from localhost ([::1] helo=lists1p.gnu.org)
by lists.gnu.org with esmtp (Exim 4.90_1)
(envelope-from <qemu-devel-bounces@nongnu.org>)
id 1tJe1d-0003OX-DU; Fri, 06 Dec 2024 14:30:05 -0500
Received: from eggs.gnu.org ([2001:470:142:3::10])
by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
(Exim 4.90_1) (envelope-from <pierrick.bouvier@linaro.org>)
id 1tJe0w-0002sw-1e
for qemu-devel@nongnu.org; Fri, 06 Dec 2024 14:29:22 -0500
Received: from mail-pf1-x42e.google.com ([2607:f8b0:4864:20::42e])
by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128)
(Exim 4.90_1) (envelope-from <pierrick.bouvier@linaro.org>)
id 1tJe0r-0005G2-6f
for qemu-devel@nongnu.org; Fri, 06 Dec 2024 14:29:20 -0500
Received: by mail-pf1-x42e.google.com with SMTP id
d2e1a72fcca58-724f42c1c38so2252422b3a.1
for <qemu-devel@nongnu.org>; Fri, 06 Dec 2024 11:29:14 -0800 (PST)
Received: from pc.. (216-180-64-156.dyn.novuscom.net. [216.180.64.156])
by smtp.gmail.com with ESMTPSA id
d9443c01a7336-215f8ef9fcdsm32110205ad.146.2024.12.06.11.29.11
(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
Fri, 06 Dec 2024 11:29:12 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=linaro.org; s=google; t=1733513353; x=1734118153; darn=nongnu.org;
h=content-transfer-encoding:mime-version:references:in-reply-to
:message-id:date:subject:cc:to:from:from:to:cc:subject:date
:message-id:reply-to;
bh=KcbaNjWF8lnwvj+PtEoJozlcQBiv6h5KPfhVvS5OAGE=;
b=GkOUllCKNw+ZSOFey7MkwD+NR56Q7EHOKverAmVWvMehgMwHYAVhfrH1nJxcWZZffC
Nn0ktfsqJ70jAverfHLxppf5XRFQZW/SBIYWpHPlYvVE3M1aJyySitxuNQwgOJGNAFkm
lZtp1rDF+yREd6dZjGXX7i67Xb6ypH/1RpmmHAffShj7bSNmSLuBi2VW2kHCO6OH0tQy
HlNvW+y+SmWnxnqRrteabt6Si7OWZ/xtTQ4tNU8rDbXcXeWUEo1NsNqk/T8VgvE//LDH
rutr33oCi6YvQT4mrWLOnkCSk3Ju1gnMA+IkLDTnPXoTlI5hMTnrnUrnwTXf9QKtSMcN
djDA==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20230601; t=1733513353; x=1734118153;
h=content-transfer-encoding:mime-version:references:in-reply-to
:message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc
:subject:date:message-id:reply-to;
bh=KcbaNjWF8lnwvj+PtEoJozlcQBiv6h5KPfhVvS5OAGE=;
b=rym3o+o/RHv4IRBWomhW1S1D+Q7hT6nQnIBwcHXmHMgNNK16RUPlCLRMeW78NRMqIn
eKHUujmAiTbL7j5iFeCY3eX8M6tqmLUw4yYeyteWG2dy4GVdXDe5lgcCmS0EtQmX8ycm
fJBggOL5adumc859oMGQX57mnrDx3togRQf455ft+8GUjoXwEUya3YH1KHhKygaNVSHE
j3labJjc1zHuknCI8IOGJYq0JGQBGrE076prjHre5rHI1VFzBAhxhMEFRHZcH6E0/iJa
WH2YtcRV+FBdiyi4MBCu3gZdjxsO/LciBeh9tPmGJvzl+6qDNAsUFvGH2VIG9zXHcxjA
S4lw==
X-Gm-Message-State: AOJu0YybwDRoh6FKQU/xdE007b1p45TMcZRriFUi6Mpo4DzOOQKQkjTP
m8FuqKKsMhcW4sP1aDklv0+k03ZLzSufYFDZYAPjkBPHBC47NEhgHK5I3bk0Qei4t3MMgd4Bd8H
TIvg=
X-Gm-Gg: ASbGncvkopXiVN7pLvz8LWtjdjkDM9n0/4Q7orQSiFsjco9lX8BzgJKVcV831LYhVw/
ez35kzOZCbPaLbM0gwBStOH4uFW1RCEfXTGLUGUlwsX0l6w0SL23fa9LyD2pBul6lsj+uui9W41
Dc3RBe6XzXMlF+gHoYORVEAH/SFFNtX9+MR22QBIpS3/ZuaTzK2QqMM5IPCK9U1esDKU4orpDnQ
3sUSJtpRWY5BBfMl67rZjHXQhzyMmlBQJKIE06FbiuXRnGlmCm1SZYD2vNPkSYxD5+c3vJCzaP+
iyp1ZS06
X-Google-Smtp-Source:
AGHT+IHFufaYCMClPTi98G1CjKlYsKdw5Xn8o2W/Sp0Nd43LyJNVgZeaRPg2/bVDivENzf+ncij9aw==
X-Received: by 2002:a17:902:f611:b0:216:282d:c692 with SMTP id
d9443c01a7336-216282dd85emr12524825ad.34.1733513353005;
Fri, 06 Dec 2024 11:29:13 -0800 (PST)
From: Pierrick Bouvier <pierrick.bouvier@linaro.org>
To: qemu-devel@nongnu.org
Cc: Peter Maydell <peter.maydell@linaro.org>,
=?UTF-8?q?Alex=20Benn=C3=A9e?= <alex.bennee@linaro.org>,
Richard Henderson <richard.henderson@linaro.org>, qemu-block@nongnu.org,
philmd@linaro.org, Paolo Bonzini <pbonzini@redhat.com>,
Fabiano Rosas <farosas@suse.de>,
Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>,
=?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= <berrange@redhat.com>,
Markus Armbruster <armbru@redhat.com>, qemu-arm@nongnu.org,
Michael Roth <michael.roth@amd.com>, Peter Xu <peterx@redhat.com>,
gustavo.romero@linaro.org, Yuri Benditovich <yuri.benditovich@daynix.com>,
Eric Blake <eblake@redhat.com>, Andrew Melnychenko <andrew@daynix.com>,
Konstantin Kostiuk <kkostiuk@redhat.com>, Kevin Wolf <kwolf@redhat.com>,
Thomas Huth <thuth@redhat.com>, Jason Wang <jasowang@redhat.com>,
manos.pitsidianakis@linaro.org,
Pierrick Bouvier <pierrick.bouvier@linaro.org>
Subject: [PATCH v3 4/6] docs/devel: add information on how to setup build
environments
Date: Fri, 6 Dec 2024 11:28:58 -0800
Message-Id: <20241206192900.3893118-5-pierrick.bouvier@linaro.org>
X-Mailer: git-send-email 2.39.5
In-Reply-To: <20241206192900.3893118-1-pierrick.bouvier@linaro.org>
References: <20241206192900.3893118-1-pierrick.bouvier@linaro.org>
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17
as permitted sender) client-ip=209.51.188.17;
envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org;
helo=lists.gnu.org;
Received-SPF: pass client-ip=2607:f8b0:4864:20::42e;
envelope-from=pierrick.bouvier@linaro.org; helo=mail-pf1-x42e.google.com
X-Spam_score_int: -19
X-Spam_score: -2.0
X-Spam_bar: --
X-Spam_report: (-2.0 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1,
DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1,
RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001,
URIBL_SBL_A=0.1 autolearn=unavailable autolearn_force=no
X-Spam_action: no action
X-BeenThere: qemu-devel@nongnu.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: <qemu-devel.nongnu.org>
List-Unsubscribe: <https://lists.nongnu.org/mailman/options/qemu-devel>,
<mailto:qemu-devel-request@nongnu.org?subject=unsubscribe>
List-Archive: <https://lists.nongnu.org/archive/html/qemu-devel>
List-Post: <mailto:qemu-devel@nongnu.org>
List-Help: <mailto:qemu-devel-request@nongnu.org?subject=help>
List-Subscribe: <https://lists.nongnu.org/mailman/listinfo/qemu-devel>,
<mailto:qemu-devel-request@nongnu.org?subject=subscribe>
Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org
Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org
X-ZohoMail-DKIM: pass (identity @linaro.org)
X-ZM-MESSAGEID: 1733513480185116600
Content-Type: text/plain; charset="utf-8"
MacOS and Linux are straightforward, but Windows needs a bit more
details.
Signed-off-by: Pierrick Bouvier <pierrick.bouvier@linaro.org>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
---
docs/about/build-platforms.rst | 4 +-
docs/devel/build-environment.rst | 118 +++++++++++++++++++++++++++++++
docs/devel/index-build.rst | 1 +
3 files changed, 122 insertions(+), 1 deletion(-)
create mode 100644 docs/devel/build-environment.rst
diff --git a/docs/about/build-platforms.rst b/docs/about/build-platforms.rst
index d8b0445157f..482b09819c1 100644
--- a/docs/about/build-platforms.rst
+++ b/docs/about/build-platforms.rst
@@ -29,6 +29,9 @@ The `Repology`_ site is a useful resource to identify
currently shipped versions of software in various operating systems,
though it does not cover all distros listed below.
=20
+You can find how to install build dependencies for different systems on the
+:ref:`setup-build-env` page.
+
Supported host architectures
----------------------------
=20
@@ -130,7 +133,6 @@ Optional build dependencies
cross compilation using ``docker`` or ``podman``, or to use pre-built
binaries distributed with QEMU.
=20
-
Windows
-------
=20
diff --git a/docs/devel/build-environment.rst b/docs/devel/build-environmen=
t.rst
new file mode 100644
index 00000000000..f133ef2e012
--- /dev/null
+++ b/docs/devel/build-environment.rst
@@ -0,0 +1,118 @@
+
+.. _setup-build-env:
+
+Setup build environment
+=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
+
+QEMU uses a lot of dependencies on the host system. glib2 is used everywhe=
re in
+the code base, and most of the other dependencies are optional.
+
+We present here simple instructions to enable native builds on most popular
+systems.
+
+You can find additional instructions on `QEMU wiki <https://wiki.qemu.org/=
>`_:
+
+- `Linux <https://wiki.qemu.org/Hosts/Linux>`_
+- `MacOS <https://wiki.qemu.org/Hosts/Mac>`_
+- `Windows <https://wiki.qemu.org/Hosts/W32>`_
+- `BSD <https://wiki.qemu.org/Hosts/BSD>`_
+
+Note: Installing dependencies using your package manager build dependencie=
s may
+miss out on deps that have been newly introduced in qemu.git. In more, it =
misses
+deps the distribution has decided to exclude.
+
+Linux
+-----
+
+Fedora
+++++++
+
+::
+
+ sudo dnf update && sudo dnf builddep qemu
+
+Debian/Ubuntu
++++++++++++++
+
+You first need to enable `Sources List <https://wiki.debian.org/SourcesLis=
t>`_.
+Then, use apt to install dependencies:
+
+::
+
+ sudo apt update && sudo apt build-dep qemu
+
+MacOS
+-----
+
+You first need to install `Homebrew <https://brew.sh/>`_. Then, use it to
+install dependencies:
+
+::
+
+ brew update && brew install $(brew deps --include-build qemu)
+
+Windows
+-------
+
+You first need to install `MSYS2 <https://www.msys2.org/>`_.
+MSYS2 offers `different environments <https://www.msys2.org/docs/environme=
nts/>`_.
+x86_64 environments are based on GCC, while aarch64 is based on Clang.
+
+We recommend to use MINGW64 for windows-x86_64 and CLANGARM64 for windows-=
aarch64
+(only available on windows-aarch64 hosts).
+
+Then, you can open a windows shell, and enter msys2 env using:
+
+::
+
+ c:/msys64/msys2_shell.cmd -defterm -here -no-start -mingw64
+ # Replace -ucrt64 by -clangarm64 or -ucrt64 for other environments.
+
+MSYS2 package manager does not offer a built-in way to install build
+dependencies. You can start with this list of packages using pacman:
+
+Note: Dependencies need to be installed again if you use a different MSYS2
+environment.
+
+::
+
+ # update MSYS2 itself, you need to reopen your shell at the end.
+ pacman -Syu
+ pacman -S \
+ base-devel binutils bison diffutils flex git grep make sed \
+ ${MINGW_PACKAGE_PREFIX}-toolchain \
+ ${MINGW_PACKAGE_PREFIX}-glib2 \
+ ${MINGW_PACKAGE_PREFIX}-gtk3 \
+ ${MINGW_PACKAGE_PREFIX}-libnfs \
+ ${MINGW_PACKAGE_PREFIX}-libssh \
+ ${MINGW_PACKAGE_PREFIX}-ninja \
+ ${MINGW_PACKAGE_PREFIX}-pixman \
+ ${MINGW_PACKAGE_PREFIX}-pkgconf \
+ ${MINGW_PACKAGE_PREFIX}-python \
+ ${MINGW_PACKAGE_PREFIX}-SDL2 \
+ ${MINGW_PACKAGE_PREFIX}-zstd
+
+If you want to install all dependencies, it's possible to use recipe used =
to
+build QEMU in MSYS2 itself.
+
+::
+
+ pacman -S wget
+ wget https://raw.githubusercontent.com/msys2/MINGW-packages/refs/heads=
/master/mingw-w64-qemu/PKGBUILD
+ # Some packages may be missing for your environment, installation will=
still
+ # be done though.
+ makepkg -s PKGBUILD || true
+
+Build on windows-aarch64
+++++++++++++++++++++++++
+
+When trying to cross compile meson for x86_64 using UCRT64 or MINGW64 env,
+configure will run into an error because the cpu detected is not correct.
+
+Meson detects x86_64 processes emulated, so you need to manually set the c=
pu,
+and force a cross compilation (with empty prefix).
+
+::
+
+ ./configure --cpu=3Dx86_64 --cross-prefix=3D
+
diff --git a/docs/devel/index-build.rst b/docs/devel/index-build.rst
index 0023953be36..0745c81a264 100644
--- a/docs/devel/index-build.rst
+++ b/docs/devel/index-build.rst
@@ -8,6 +8,7 @@ some of the basics if you are adding new files and targets =
to the build.
:maxdepth: 3
=20
build-system
+ build-environment
kconfig
docs
qapi-code-gen
--=20
2.39.5
From nobody Mon May 12 13:51:28 2025
Delivered-To: importer@patchew.org
Authentication-Results: mx.zohomail.com;
dkim=pass;
spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as
permitted sender)
smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org;
dmarc=pass(p=none dis=none) header.from=linaro.org
ARC-Seal: i=1; a=rsa-sha256; t=1733513432; cv=none;
d=zohomail.com; s=zohoarc;
b=mzPNy8aJO5DV98ry11WLYzU1+qLvkIMDwJWxF2KHS+TFL5pgHUWpf6Q08LDFUyeqP+4dwbXxZdUSFTnoA4JD40wJ6jlyUxqaXlPQmdq1q82Y3qrPCxTC5lfAcxUceQIlF/eL0OdT10w5NUM6+s7VvL3kDEhT+HaDGT+BHWzs+kA=
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com;
s=zohoarc;
t=1733513432;
h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To;
bh=psPQ9/kLRzl9aDWDZsvLNVKSyFO68oycKe3IaPSK7ys=;
b=msa+VM4GukostMuK6IFJnIV2GMCLgaHB6j5j24x2lNY199FkTg9gZD0kC+Kphb3AW7wd64Fn6rN5AuV9uEH02KkC926m2hPGrru4wdOrJv9c2JFw0fFMaZbp/mSwGuNh/nCKDExIi/R1Pjvh8I7wCqF2kcUilUZMkFTIue8YS5w=
ARC-Authentication-Results: i=1; mx.zohomail.com;
dkim=pass;
spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as
permitted sender)
smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org;
dmarc=pass header.from=<pierrick.bouvier@linaro.org> (p=none dis=none)
Return-Path: <qemu-devel-bounces+importer=patchew.org@nongnu.org>
Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by
mx.zohomail.com
with SMTPS id 1733513432826343.0786573582618;
Fri, 6 Dec 2024 11:30:32 -0800 (PST)
Received: from localhost ([::1] helo=lists1p.gnu.org)
by lists.gnu.org with esmtp (Exim 4.90_1)
(envelope-from <qemu-devel-bounces@nongnu.org>)
id 1tJe1e-0003Rz-2x; Fri, 06 Dec 2024 14:30:06 -0500
Received: from eggs.gnu.org ([2001:470:142:3::10])
by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
(Exim 4.90_1) (envelope-from <pierrick.bouvier@linaro.org>)
id 1tJe0y-0002to-4o
for qemu-devel@nongnu.org; Fri, 06 Dec 2024 14:29:27 -0500
Received: from mail-pl1-x631.google.com ([2607:f8b0:4864:20::631])
by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128)
(Exim 4.90_1) (envelope-from <pierrick.bouvier@linaro.org>)
id 1tJe0r-0005GT-5m
for qemu-devel@nongnu.org; Fri, 06 Dec 2024 14:29:22 -0500
Received: by mail-pl1-x631.google.com with SMTP id
d9443c01a7336-2156e078563so19114625ad.2
for <qemu-devel@nongnu.org>; Fri, 06 Dec 2024 11:29:15 -0800 (PST)
Received: from pc.. (216-180-64-156.dyn.novuscom.net. [216.180.64.156])
by smtp.gmail.com with ESMTPSA id
d9443c01a7336-215f8ef9fcdsm32110205ad.146.2024.12.06.11.29.13
(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
Fri, 06 Dec 2024 11:29:13 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=linaro.org; s=google; t=1733513354; x=1734118154; darn=nongnu.org;
h=content-transfer-encoding:mime-version:references:in-reply-to
:message-id:date:subject:cc:to:from:from:to:cc:subject:date
:message-id:reply-to;
bh=psPQ9/kLRzl9aDWDZsvLNVKSyFO68oycKe3IaPSK7ys=;
b=xsf2mbxIUIthuS0uSpNaAinHclzoQlJo7cAVi6jXDjRjAeJFb+jgC10ApL/wMGxD7G
EbWbqNSGwp5DLHJki1lqja4SgqSxQ7XqmD6ctnx9KlXd+p1HiKA4XtIGt0ak3QjcxZ9C
Fuk4Ldo3NEgTqgpSsTzt3yAHsU6ri28LFtTqybwfXM0zcpSdueb2Ip9//1D/CkRtta/j
DZRMuQw2Ky8Kzl/RoWyZH+rf3KVq0OtMgNdqm2d1hI6PlA99/gVD+C9A93vK8HBgpR3g
cuoTwK4GXDIXuPSAgphXKVFRL8prW9Nz4IlXktk721Vu2M7Si32YEMBwcioN0tRDdvT9
xeHw==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20230601; t=1733513354; x=1734118154;
h=content-transfer-encoding:mime-version:references:in-reply-to
:message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc
:subject:date:message-id:reply-to;
bh=psPQ9/kLRzl9aDWDZsvLNVKSyFO68oycKe3IaPSK7ys=;
b=qSGr+80BKdrQJ7tfq3XhJ3f+eJOK7D66CZRUWb8cNBMhRwboADvkZYvIWbmrLHppOz
nSOC+mZkCzryFnqJEDxRbcGrjzALLlfOv4dKMusSNAoOcfMQvmJOvZHnir8MdTbDa5nK
rEKi3fpXayikN78rePycHY/8V1X/raE8ov6wYWhG+ZtnMStwWUTWJCYzuZqrsWb3t918
fldjeUibp59MNB0vybIRcx3qFjEz2yyBZ7+Ksiw2ZNCa3bKtWA7dUc6MkxH9zHJv+k3/
S3nkzUBeKjpf1qsInF3stO4hVicMA4zJ45UQJioYUDHtL6QYHn3L3PsWI9baaoh7KAll
6Olg==
X-Gm-Message-State: AOJu0YydDTkj/XE8K6VUwrzJJw3mSj2Dqyn1Ui3WpICKm3YXJ8sAysSE
gVWa79uI/FizVWRtdLf1G7h+XMGkjjtJER0zU3pjrvILDFaUuivLeaRHwycI7PVmbjcPa8lfZLN
eWFc=
X-Gm-Gg: ASbGncv5gNoETNPeoYujo4A5V92I8c+L8AuJlIIBMbepRyJsXStH2e+C9gWg03KZGnv
jLoCs466E3QyMWfFEDpsi6wwSkAgavAplMlJqWpNGdmNJZmEfxeEpvXsxJSuTn9gimaYncM7Vjd
p2tHFEE3+xi0AW8SaVxBckpnZGNHqMqFGNmreBTMefqU+MVfQc1+eR7+ajftyF7/y7h3bRoztGd
KDPc8PS6zmBISzSKi8wEmHFFKx3H37MzQOxo4Dy8x0m/2481gkxT40hyPeKJxqpKMhbi2/BfHlH
9SgIAiHk
X-Google-Smtp-Source:
AGHT+IFo7lUnY+/LIV0BuvJEZTvoEjn4+azJSV/vS1yHO4y+PxzqwxZNo5heDdXWn0zy2ZAG3V0IoQ==
X-Received: by 2002:a17:903:24d:b0:216:1367:7e3d with SMTP id
d9443c01a7336-21614d67fc3mr62231345ad.31.1733513354123;
Fri, 06 Dec 2024 11:29:14 -0800 (PST)
From: Pierrick Bouvier <pierrick.bouvier@linaro.org>
To: qemu-devel@nongnu.org
Cc: Peter Maydell <peter.maydell@linaro.org>,
=?UTF-8?q?Alex=20Benn=C3=A9e?= <alex.bennee@linaro.org>,
Richard Henderson <richard.henderson@linaro.org>, qemu-block@nongnu.org,
philmd@linaro.org, Paolo Bonzini <pbonzini@redhat.com>,
Fabiano Rosas <farosas@suse.de>,
Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>,
=?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= <berrange@redhat.com>,
Markus Armbruster <armbru@redhat.com>, qemu-arm@nongnu.org,
Michael Roth <michael.roth@amd.com>, Peter Xu <peterx@redhat.com>,
gustavo.romero@linaro.org, Yuri Benditovich <yuri.benditovich@daynix.com>,
Eric Blake <eblake@redhat.com>, Andrew Melnychenko <andrew@daynix.com>,
Konstantin Kostiuk <kkostiuk@redhat.com>, Kevin Wolf <kwolf@redhat.com>,
Thomas Huth <thuth@redhat.com>, Jason Wang <jasowang@redhat.com>,
manos.pitsidianakis@linaro.org,
Pierrick Bouvier <pierrick.bouvier@linaro.org>
Subject: [PATCH v3 5/6] docs: add a codebase section
Date: Fri, 6 Dec 2024 11:28:59 -0800
Message-Id: <20241206192900.3893118-6-pierrick.bouvier@linaro.org>
X-Mailer: git-send-email 2.39.5
In-Reply-To: <20241206192900.3893118-1-pierrick.bouvier@linaro.org>
References: <20241206192900.3893118-1-pierrick.bouvier@linaro.org>
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17
as permitted sender) client-ip=209.51.188.17;
envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org;
helo=lists.gnu.org;
Received-SPF: pass client-ip=2607:f8b0:4864:20::631;
envelope-from=pierrick.bouvier@linaro.org; helo=mail-pl1-x631.google.com
X-Spam_score_int: -20
X-Spam_score: -2.1
X-Spam_bar: --
X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1,
DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1,
RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001,
SPF_PASS=-0.001 autolearn=ham autolearn_force=no
X-Spam_action: no action
X-BeenThere: qemu-devel@nongnu.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: <qemu-devel.nongnu.org>
List-Unsubscribe: <https://lists.nongnu.org/mailman/options/qemu-devel>,
<mailto:qemu-devel-request@nongnu.org?subject=unsubscribe>
List-Archive: <https://lists.nongnu.org/archive/html/qemu-devel>
List-Post: <mailto:qemu-devel@nongnu.org>
List-Help: <mailto:qemu-devel-request@nongnu.org?subject=help>
List-Subscribe: <https://lists.nongnu.org/mailman/listinfo/qemu-devel>,
<mailto:qemu-devel-request@nongnu.org?subject=subscribe>
Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org
Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org
X-ZohoMail-DKIM: pass (identity @linaro.org)
X-ZM-MESSAGEID: 1733513434120116600
Content-Type: text/plain; charset="utf-8"
Present the various parts of QEMU and organization of codebase.
Signed-off-by: Pierrick Bouvier <pierrick.bouvier@linaro.org>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
---
docs/about/emulation.rst | 2 +
docs/devel/codebase.rst | 218 +++++++++++++++++++++++++
docs/devel/decodetree.rst | 2 +
docs/devel/ebpf_rss.rst | 2 +
docs/devel/index-internals.rst | 2 +
docs/devel/index.rst | 1 +
docs/devel/migration/main.rst | 2 +
docs/devel/qapi-code-gen.rst | 1 +
docs/devel/testing/main.rst | 9 +-
docs/devel/testing/qtest.rst | 2 +
docs/index.rst | 2 +
docs/interop/qemu-ga.rst | 2 +
docs/system/qemu-block-drivers.rst.inc | 2 +
docs/tools/qemu-storage-daemon.rst | 2 +
docs/user/main.rst | 6 +
15 files changed, 254 insertions(+), 1 deletion(-)
create mode 100644 docs/devel/codebase.rst
diff --git a/docs/about/emulation.rst b/docs/about/emulation.rst
index 3028d5fff7a..3bc3579434f 100644
--- a/docs/about/emulation.rst
+++ b/docs/about/emulation.rst
@@ -176,6 +176,8 @@ for that architecture.
- System
- Tensilica ISS SIMCALL
=20
+.. _tcg-plugins:
+
TCG Plugins
-----------
=20
diff --git a/docs/devel/codebase.rst b/docs/devel/codebase.rst
new file mode 100644
index 00000000000..e926ef4e92e
--- /dev/null
+++ b/docs/devel/codebase.rst
@@ -0,0 +1,218 @@
+=3D=3D=3D=3D=3D=3D=3D=3D
+Codebase
+=3D=3D=3D=3D=3D=3D=3D=3D
+
+This section presents the various parts of QEMU and how the codebase is
+organized.
+
+Beyond giving succint descriptions, the goal is to offer links to various
+parts of the documentation/codebase.
+
+Subsystems
+----------
+
+An exhaustive list of subsystems and associated files can be found in the
+`MAINTAINERS <https://gitlab.com/qemu-project/qemu/-/blob/master/MAINTAINE=
RS>`_
+file.
+
+Some of the main QEMU subsystems are:
+
+- `Accelerators<Accelerators>`
+- Block devices and `disk images<disk images>` support
+- `CI<ci>` and `Tests<testing>`
+- `Devices<device-emulation>` & Board models
+- `Documentation <documentation-root>`
+- `GDB support<GDB usage>`
+- `Migration<migration>`
+- `Monitor<QEMU monitor>`
+- :ref:`QOM (QEMU Object Model)<qom>`
+- `System mode<System emulation>`
+- :ref:`TCG (Tiny Code Generator)<tcg>`
+- `User mode<user-mode>` (`Linux<linux-user-mode>` & `BSD<bsd-user-mode>`)
+- User Interfaces
+
+More documentation on QEMU subsystems can be found on :ref:`internal-subsy=
stem`
+page.
+
+The Grand tour
+--------------
+
+We present briefly here what every folder of the codebase contains. Hop on!
+
+The folder name links here will take you to that folder in our gitlab
+repository. Other links will take you to more detailed documentation for t=
hat
+subsystem, where we have it. Unfortunately not every subsystem has documen=
tation
+yet, so sometimes the source code is all you have.
+
+* `accel <https://gitlab.com/qemu-project/qemu/-/tree/master/accel>`_:
+ Infrastructure and architecture agnostic code related to the various
+ `accelerators <Accelerators>` supported by QEMU
+ (TCG, KVM, hvf, whpx, xen, nvmm).
+ Contains interfaces for operations that will be implemented per
+ `target <https://gitlab.com/qemu-project/qemu/-/tree/master/target>`_.
+* `audio <https://gitlab.com/qemu-project/qemu/-/tree/master/audio>`_:
+ Audio (host) support.
+* `authz <https://gitlab.com/qemu-project/qemu/-/tree/master/authz>`_:
+ `QEMU Authorization framework<client authorization>`.
+* `backends <https://gitlab.com/qemu-project/qemu/-/tree/master/backends>`=
_:
+ Various backends used for device emulation.
+* `block <https://gitlab.com/qemu-project/qemu/-/tree/master/block>`_:
+ Block devices and `image formats<disk images>` implementation.
+* `bsd-user <https://gitlab.com/qemu-project/qemu/-/tree/master/bsd-user>`=
_:
+ `BSD User mode<bsd-user-mode>`.
+* build: Where the code built goes by default. You can tell the QEMU build
+ system to put the built code anywhere else you like.
+* `chardev <https://gitlab.com/qemu-project/qemu/-/tree/master/chardev>`_:
+ Various backends used by char devices.
+* `common-user <https://gitlab.com/qemu-project/qemu/-/tree/master/common-=
user>`_:
+ User-mode assembly code for dealing with signals occuring during syscall=
s.
+* `configs <https://gitlab.com/qemu-project/qemu/-/tree/master/configs>`_:
+ Makefiles defining configurations to build QEMU.
+* `contrib <https://gitlab.com/qemu-project/qemu/-/tree/master/contrib>`_:
+ Community contributed devices/plugins/tools.
+* `crypto <https://gitlab.com/qemu-project/qemu/-/tree/master/crypto>`_:
+ Cryptographic algorithms used in QEMU.
+* `disas <https://gitlab.com/qemu-project/qemu/-/tree/master/disas>`_:
+ Disassembly functions used by QEMU target code.
+* `docs <https://gitlab.com/qemu-project/qemu/-/tree/master/docs>`_:
+ QEMU Documentation.
+* `dump <https://gitlab.com/qemu-project/qemu/-/tree/master/dump>`_:
+ Code to dump memory of a running VM.
+* `ebpf <https://gitlab.com/qemu-project/qemu/-/tree/master/ebpf>`_:
+ eBPF program support in QEMU. `virtio-net RSS<ebpf-rss>` uses it.
+* `fpu <https://gitlab.com/qemu-project/qemu/-/tree/master/fpu>`_:
+ Floating-point software emulation.
+* `fsdev <https://gitlab.com/qemu-project/qemu/-/tree/master/fsdev>`_:
+ `VirtFS <https://www.linux-kvm.org/page/VirtFS>`_ support.
+* `gdbstub <https://gitlab.com/qemu-project/qemu/-/tree/master/gdbstub>`_:
+ `GDB <GDB usage>` support.
+* `gdb-xml <https://gitlab.com/qemu-project/qemu/-/tree/master/gdb-xml>`_:
+ Set of XML files describing architectures and used by `gdbstub <GDB usag=
e>`.
+* `host <https://gitlab.com/qemu-project/qemu/-/tree/master/host>`_:
+ Various architecture specific header files (crypto, atomic, memory
+ operations).
+* `linux-headers <https://gitlab.com/qemu-project/qemu/-/tree/master/linux=
-headers>`_:
+ A subset of headers imported from Linux kernel and used for implementing
+ KVM support and user-mode.
+* `linux-user <https://gitlab.com/qemu-project/qemu/-/tree/master/linux-us=
er>`_:
+ `User mode <user-mode>` implementation. Contains one folder per target
+ architecture.
+* `.gitlab-ci.d <https://gitlab.com/qemu-project/qemu/-/tree/master/.gitla=
b-ci.d>`_:
+ `CI <ci>` yaml and scripts.
+* `include <https://gitlab.com/qemu-project/qemu/-/tree/master/include>`_:
+ All headers associated to different subsystems in QEMU. The hierachy used
+ mirrors source code organization and naming.
+* `hw <https://gitlab.com/qemu-project/qemu/-/tree/master/hw>`_:
+ `Devices <device-emulation>` and boards emulation. Devices are categoriz=
ed by
+ type/protocol/architecture and located in associated subfolder.
+* `io <https://gitlab.com/qemu-project/qemu/-/tree/master/io>`_:
+ QEMU `I/O channels <https://lists.gnu.org/archive/html/qemu-devel/2015-1=
1/msg04208.html>`_.
+* `libdecnumber <https://gitlab.com/qemu-project/qemu/-/tree/master/libdec=
number>`_:
+ Import of gcc library, used to implement decimal number arithmetic.
+* `migration <https://gitlab.com/qemu-project/qemu/-/tree/master/migration=
>`__:
+ `Migration framework <migration>`.
+* `monitor <https://gitlab.com/qemu-project/qemu/-/tree/master/monitor>`_:
+ `Monitor <QEMU monitor>` implementation (HMP & QMP).
+* `nbd <https://gitlab.com/qemu-project/qemu/-/tree/master/nbd>`_:
+ QEMU `NBD (Network Block Device) <nbd>` server.
+* `net <https://gitlab.com/qemu-project/qemu/-/tree/master/net>`_:
+ Network (host) support.
+* `pc-bios <https://gitlab.com/qemu-project/qemu/-/tree/master/pc-bios>`_:
+ Contains pre-built firmware binaries and boot images, ready to use in
+ QEMU without compilation.
+* `plugins <https://gitlab.com/qemu-project/qemu/-/tree/master/plugins>`_:
+ :ref:`TCG plugins <tcg-plugins>` core implementation. Plugins can be fou=
nd in
+ `tests <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/tcg/plu=
gins>`__
+ and `contrib <https://gitlab.com/qemu-project/qemu/-/tree/master/contrib=
/plugins>`__
+ folders.
+* `po <https://gitlab.com/qemu-project/qemu/-/tree/master/po>`_:
+ Translation files.
+* `python <https://gitlab.com/qemu-project/qemu/-/tree/master/python>`_:
+ Python part of our build/test system.
+* `qapi <https://gitlab.com/qemu-project/qemu/-/tree/master/qapi>`_:
+ `QAPI <qapi>` implementation.
+* `qobject <https://gitlab.com/qemu-project/qemu/-/tree/master/qobject>`_:
+ QEMU Object implementation.
+* `qga <https://gitlab.com/qemu-project/qemu/-/tree/master/qga>`_:
+ QEMU `Guest agent <qemu-ga>` implementation.
+* `qom <https://gitlab.com/qemu-project/qemu/-/tree/master/qom>`_:
+ QEMU :ref:`Object model <qom>` implementation, with monitor associated c=
ommands.
+* `replay <https://gitlab.com/qemu-project/qemu/-/tree/master/replay>`_:
+ QEMU :ref:`Record/replay <replay>` implementation.
+* `roms <https://gitlab.com/qemu-project/qemu/-/tree/master/roms>`_:
+ Contains source code for various firmware and ROMs, which can be compile=
d if
+ custom or updated versions are needed.
+* `rust <https://gitlab.com/qemu-project/qemu/-/tree/master/rust>`_:
+ Rust integration in QEMU. It contains the new interfaces defined and
+ associated devices using it.
+* `scripts <https://gitlab.com/qemu-project/qemu/-/tree/master/scripts>`_:
+ Collection of scripts used in build and test systems, and various
+ tools for QEMU codebase and execution traces.
+* `scsi <https://gitlab.com/qemu-project/qemu/-/tree/master/scsi>`_:
+ Code related to SCSI support, used by SCSI devices.
+* `semihosting <https://gitlab.com/qemu-project/qemu/-/tree/master/semihos=
ting>`_:
+ QEMU `Semihosting <Semihosting>` implementation.
+* `stats <https://gitlab.com/qemu-project/qemu/-/tree/master/stats>`_:
+ `Monitor <QEMU monitor>` stats commands implementation.
+* `storage-daemon <https://gitlab.com/qemu-project/qemu/-/tree/master/stor=
age-daemon>`_:
+ QEMU `Storage daemon <storage-daemon>` implementation.
+* `stubs <https://gitlab.com/qemu-project/qemu/-/tree/master/stubs>`_:
+ Various stubs (empty functions) used to compile QEMU with specific
+ configurations.
+* `subprojects <https://gitlab.com/qemu-project/qemu/-/tree/master/subproj=
ects>`_:
+ QEMU submodules used by QEMU build system.
+* `system <https://gitlab.com/qemu-project/qemu/-/tree/master/system>`_:
+ QEMU `system mode <System emulation>` implementation (cpu, mmu, boot sup=
port).
+* `target <https://gitlab.com/qemu-project/qemu/-/tree/master/target>`_:
+ Contains code for all target architectures supported (one subfolder
+ per arch). For every architecture, you can find accelerator specific
+ implementations.
+* `tcg <https://gitlab.com/qemu-project/qemu/-/tree/master/tcg>`_:
+ :ref:`TCG <tcg>` related code.
+ Contains one subfolder per host supported architecture.
+* `tests <https://gitlab.com/qemu-project/qemu/-/tree/master/tests>`_:
+ QEMU `test <testing>` suite
+
+ - `avocado <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/avo=
cado>`_:
+ Functional tests booting full VM using `Avocado framework <checkavocad=
o-ref>`.
+ Those tests will be transformed and moved into
+ `tests/functional <https://gitlab.com/qemu-project/qemu/-/tree/master/=
tests/functional>`_
+ in the future.
+ - `data <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/data>`=
_:
+ Data for various tests.
+ - `decode <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/deco=
de>`_:
+ Testsuite for :ref:`decodetree <decodetree>` implementation.
+ - `docker <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/dock=
er>`_:
+ Code and scripts to create `containers <container-ref>` used in `CI <c=
i>`.
+ - `fp <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/fp>`_:
+ QEMU testsuite for soft float implementation.
+ - `functional <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/=
functional>`_:
+ `Functional tests <checkfunctional-ref>` (full VM boot).
+ - `lcitool <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/lci=
tool>`_:
+ Generate dockerfiles for CI containers.
+ - `migration <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/m=
igration>`_:
+ Test scripts and data for `Migration framework <migration>`.
+ - `multiboot <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/m=
ultiboot>`_:
+ Test multiboot functionality for x86_64/i386.
+ - `qapi-schema <https://gitlab.com/qemu-project/qemu/-/tree/master/tests=
/qapi-schema>`_:
+ Test scripts and data for `QAPI <qapi-tests>`.
+ - `qemu-iotests <https://gitlab.com/qemu-project/qemu/-/tree/master/test=
s/qemu-iotests>`_:
+ `Disk image and block tests <qemu-iotests>`.
+ - `qtest <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/qtest=
>`_:
+ `Device emulation testing <qtest>`.
+ - `tcg <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/tcg>`__:
+ `TCG related tests <checktcg-ref>`. Contains code per architecture
+ (subfolder) and multiarch tests as well.
+ - `tsan <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/tsan>`=
_:
+ `Suppressions <tsan-suppressions>` for thread sanitizer.
+ - `uefi-test-tools <https://gitlab.com/qemu-project/qemu/-/tree/master/t=
ests/uefi-test-tools>`_:
+ Test tool for UEFI support.
+ - `unit <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/unit>`=
_:
+ QEMU `Unit tests <unit-tests>`.
+* `trace <https://gitlab.com/qemu-project/qemu/-/tree/master/trace>`_:
+ :ref:`Tracing framework <tracing>`. Used to print information associated=
to various
+ events during execution.
+* `ui <https://gitlab.com/qemu-project/qemu/-/tree/master/ui>`_:
+ QEMU User interfaces.
+* `util <https://gitlab.com/qemu-project/qemu/-/tree/master/util>`_:
+ Utility code used by other parts of QEMU.
diff --git a/docs/devel/decodetree.rst b/docs/devel/decodetree.rst
index e3392aa7057..98ad33a4870 100644
--- a/docs/devel/decodetree.rst
+++ b/docs/devel/decodetree.rst
@@ -1,3 +1,5 @@
+.. _decodetree:
+
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
Decodetree Specification
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
diff --git a/docs/devel/ebpf_rss.rst b/docs/devel/ebpf_rss.rst
index 4a68682b31a..ed5d33767bd 100644
--- a/docs/devel/ebpf_rss.rst
+++ b/docs/devel/ebpf_rss.rst
@@ -1,3 +1,5 @@
+.. _ebpf-rss:
+
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D
eBPF RSS virtio-net support
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D
diff --git a/docs/devel/index-internals.rst b/docs/devel/index-internals.rst
index ab9fbc44826..bca597c6589 100644
--- a/docs/devel/index-internals.rst
+++ b/docs/devel/index-internals.rst
@@ -1,3 +1,5 @@
+.. _internal-subsystem:
+
Internal Subsystem Information
------------------------------
=20
diff --git a/docs/devel/index.rst b/docs/devel/index.rst
index a53f1bfda5d..29f032d6a82 100644
--- a/docs/devel/index.rst
+++ b/docs/devel/index.rst
@@ -35,3 +35,4 @@ the :ref:`tcg_internals`.
index-api
index-internals
index-tcg
+ codebase
diff --git a/docs/devel/migration/main.rst b/docs/devel/migration/main.rst
index c2857fc2446..cdd4f4a6d7e 100644
--- a/docs/devel/migration/main.rst
+++ b/docs/devel/migration/main.rst
@@ -1,3 +1,5 @@
+.. _migration:
+
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
Migration framework
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst
index 583207a8ec2..3e26d2d1047 100644
--- a/docs/devel/qapi-code-gen.rst
+++ b/docs/devel/qapi-code-gen.rst
@@ -9,6 +9,7 @@ How to use the QAPI code generator
This work is licensed under the terms of the GNU GPL, version 2 or
later. See the COPYING file in the top-level directory.
=20
+.. _qapi:
=20
Introduction
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
diff --git a/docs/devel/testing/main.rst b/docs/devel/testing/main.rst
index 91f4dc61fb5..9869bcf0341 100644
--- a/docs/devel/testing/main.rst
+++ b/docs/devel/testing/main.rst
@@ -39,6 +39,8 @@ Before running tests, it is best to build QEMU programs f=
irst. Some tests
expect the executables to exist and will fail with obscure messages if they
cannot find them.
=20
+.. _unit-tests:
+
Unit tests
~~~~~~~~~~
=20
@@ -126,6 +128,8 @@ successfully on various hosts. The following list shows=
some best practices:
#ifdef in the codes. If the whole test suite cannot run on Windows, disa=
ble
the build in the meson.build file.
=20
+.. _qapi-tests:
+
QAPI schema tests
~~~~~~~~~~~~~~~~~
=20
@@ -160,6 +164,8 @@ check-block
are in the "auto" group).
See the "QEMU iotests" section below for more information.
=20
+.. _qemu-iotests:
+
QEMU iotests
------------
=20
@@ -679,6 +685,8 @@ The above exitcode=3D0 has TSan continue without error =
if any warnings are found.
This allows for running the test and then checking the warnings afterwards.
If you want TSan to stop and exit with error on warnings, use exitcode=3D6=
6.
=20
+.. _tsan-suppressions:
+
TSan Suppressions
~~~~~~~~~~~~~~~~~
Keep in mind that for any data race warning, although there might be a dat=
a race
@@ -901,7 +909,6 @@ You can run the avocado tests simply by executing:
=20
See :ref:`checkavocado-ref` for more details.
=20
-
.. _checktcg-ref:
=20
Testing with "make check-tcg"
diff --git a/docs/devel/testing/qtest.rst b/docs/devel/testing/qtest.rst
index c5b8546b3eb..73ef7702b7b 100644
--- a/docs/devel/testing/qtest.rst
+++ b/docs/devel/testing/qtest.rst
@@ -1,3 +1,5 @@
+.. _qtest:
+
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
QTest Device Emulation Testing Framework
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
diff --git a/docs/index.rst b/docs/index.rst
index 0b9ee9901d9..78285ebd6a4 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,6 +3,8 @@
You can adapt this file completely to your liking, but it should at lea=
st
contain the root `toctree` directive.
=20
+.. _documentation-root:
+
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D
Welcome to QEMU's documentation!
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D
diff --git a/docs/interop/qemu-ga.rst b/docs/interop/qemu-ga.rst
index 11f7bae4600..d16cc1b9f07 100644
--- a/docs/interop/qemu-ga.rst
+++ b/docs/interop/qemu-ga.rst
@@ -1,3 +1,5 @@
+.. _qemu-ga:
+
QEMU Guest Agent
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
=20
diff --git a/docs/system/qemu-block-drivers.rst.inc b/docs/system/qemu-bloc=
k-drivers.rst.inc
index 384e95ba765..cfe1acb78ae 100644
--- a/docs/system/qemu-block-drivers.rst.inc
+++ b/docs/system/qemu-block-drivers.rst.inc
@@ -500,6 +500,8 @@ What you should *never* do:
- expect it to work when loadvm'ing
- write to the FAT directory on the host system while accessing it with th=
e guest system
=20
+.. _nbd:
+
NBD access
~~~~~~~~~~
=20
diff --git a/docs/tools/qemu-storage-daemon.rst b/docs/tools/qemu-storage-d=
aemon.rst
index ea00149a63a..35ab2d78074 100644
--- a/docs/tools/qemu-storage-daemon.rst
+++ b/docs/tools/qemu-storage-daemon.rst
@@ -1,3 +1,5 @@
+.. _storage-daemon:
+
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
QEMU Storage Daemon
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
diff --git a/docs/user/main.rst b/docs/user/main.rst
index 7a126ee8093..80a77f0a0c9 100644
--- a/docs/user/main.rst
+++ b/docs/user/main.rst
@@ -1,3 +1,5 @@
+.. _user-mode:
+
QEMU User space emulator
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
=20
@@ -42,6 +44,8 @@ QEMU was conceived so that ultimately it can emulate itse=
lf. Although it
is not very useful, it is an important test to show the power of the
emulator.
=20
+.. _linux-user-mode:
+
Linux User space emulator
-------------------------
=20
@@ -175,6 +179,8 @@ Other binaries
* ``qemu-sparc64`` can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) a=
nd
SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).
=20
+.. _bsd-user-mode:
+
BSD User space emulator
-----------------------
=20
--=20
2.39.5
From nobody Mon May 12 13:51:28 2025
Delivered-To: importer@patchew.org
Authentication-Results: mx.zohomail.com;
dkim=pass;
spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as
permitted sender)
smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org;
dmarc=pass(p=none dis=none) header.from=linaro.org
ARC-Seal: i=1; a=rsa-sha256; t=1733513425; cv=none;
d=zohomail.com; s=zohoarc;
b=WZl+VNnY0AG1+XYlwuEZrd6OprKFk7/DurEkY990warYIwUEFjiexnrmKFon87R6WM8EJ88ehKYAr/f1eQAw9t59E6Nn/xmTDxG5mP2O/Ynqmn3Es9N26KtrIDYpQoNXd0Q9yZrgyiZnQ3zkjYr4oaaGv3lMB3eQYWkSM+Ln98w=
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com;
s=zohoarc;
t=1733513425;
h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To;
bh=quNdZOi6vs/DfPqpA5a+RAcvgntK93hl6bq6i2nnsOE=;
b=THA9zY8AStTngTFvoSrnUtzudVWi12wjgUmkASAYm5FmkEOcjG5tSF0M64cDcHWYMuNSktB+XE2rRzfJunDdzct2N15BJert6H2j/dxdEYHOLYR3kUh+fcdEFhM8etC1QkJ8woUIOh/nO9JBU6MiP+csurwJAZzsMLeSRKG3zI4=
ARC-Authentication-Results: i=1; mx.zohomail.com;
dkim=pass;
spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as
permitted sender)
smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org;
dmarc=pass header.from=<pierrick.bouvier@linaro.org> (p=none dis=none)
Return-Path: <qemu-devel-bounces+importer=patchew.org@nongnu.org>
Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by
mx.zohomail.com
with SMTPS id 1733513425498482.62071432627545;
Fri, 6 Dec 2024 11:30:25 -0800 (PST)
Received: from localhost ([::1] helo=lists1p.gnu.org)
by lists.gnu.org with esmtp (Exim 4.90_1)
(envelope-from <qemu-devel-bounces@nongnu.org>)
id 1tJe1Z-0003Ei-5d; Fri, 06 Dec 2024 14:30:01 -0500
Received: from eggs.gnu.org ([2001:470:142:3::10])
by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
(Exim 4.90_1) (envelope-from <pierrick.bouvier@linaro.org>)
id 1tJe0y-0002tm-4J
for qemu-devel@nongnu.org; Fri, 06 Dec 2024 14:29:27 -0500
Received: from mail-pf1-x432.google.com ([2607:f8b0:4864:20::432])
by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128)
(Exim 4.90_1) (envelope-from <pierrick.bouvier@linaro.org>)
id 1tJe0r-0005Gm-76
for qemu-devel@nongnu.org; Fri, 06 Dec 2024 14:29:22 -0500
Received: by mail-pf1-x432.google.com with SMTP id
d2e1a72fcca58-725c49b5e45so671018b3a.2
for <qemu-devel@nongnu.org>; Fri, 06 Dec 2024 11:29:16 -0800 (PST)
Received: from pc.. (216-180-64-156.dyn.novuscom.net. [216.180.64.156])
by smtp.gmail.com with ESMTPSA id
d9443c01a7336-215f8ef9fcdsm32110205ad.146.2024.12.06.11.29.14
(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
Fri, 06 Dec 2024 11:29:14 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=linaro.org; s=google; t=1733513355; x=1734118155; darn=nongnu.org;
h=content-transfer-encoding:mime-version:references:in-reply-to
:message-id:date:subject:cc:to:from:from:to:cc:subject:date
:message-id:reply-to;
bh=quNdZOi6vs/DfPqpA5a+RAcvgntK93hl6bq6i2nnsOE=;
b=UarycTlhe+mKADcTE11bfOq3slZak4/7/HIyrwoQsZUV/VrGeHS5qC274VfBtwugQY
7NVv76vutpQps+l5MUsIPd7i26v70yM4b1kaaLidm82s7UU/qOR4rRgorzKD/JTapwIp
FMbVzYOOMTJ2EBdnj6DRcudMQGe/dkCh1XFS9gNWceRYR7LY+pR6E1m/bk8LLfWbR/Cy
a4eGqgNYlSok0pWxKR1ngqx5szFhE7hB3Q5awUvd+vRRr5A03D4BZ/Nf4cxWXLcFKBMx
xHEMmVBjEHPInyfIdd6gndU0sU2PDuzRAIC468I7A5HmdJIk4/O10DomkweItXr4SN0i
DhPw==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20230601; t=1733513355; x=1734118155;
h=content-transfer-encoding:mime-version:references:in-reply-to
:message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc
:subject:date:message-id:reply-to;
bh=quNdZOi6vs/DfPqpA5a+RAcvgntK93hl6bq6i2nnsOE=;
b=TrJJpa90Uw9xKq9M+tJzDg58oy9Xz3l0zIbD0VNS7uPukyye1UAZVI5QDrRWuYBW2h
0cCoxjVfUmNHIRb4jlv5pWnnwNxsWMSB2MDZIZZrPLk9k8qGvTZ2hGqdMrWpu6fyzG4L
b/m0YEci/9OSi1xp7A1UZpn5h/mKdyN0u4GjbNb29Eg1WUyDu5oFz+r9EPk49R6SQbEc
hcUCqD0Da8D2TfYNNdo7A7/W4qQQLg6peZnN3Ze128kYZnMHnRCPlyZPcdnJFtzStS2t
cvBvrASSEqghLasZTBlkC6tt0T7JRe7EO2sJCaIhgUd9cU7lpcXmgSwLkat1eL+sWy2I
OmjA==
X-Gm-Message-State: AOJu0Yw9ABVMbg9xs3YzDP1MSbLqLomfQz6aSyPsv1MlBLdp+VMb5RtV
Q1lCdWTXJfwQAI6rRvllN5FtEdVIPJRSgDSu4PLnjxvUs851oQGbbr0Mhzo5lGVJ7zQwxbRmWsc
cjCE=
X-Gm-Gg: ASbGncuPLvmBajZDQHUcQfjhng0iaALzzoJQNL+cuS71/TjrKl8gKYMfZqcY+sdo/eM
tJcgzzSwnbdAAA9HHD+4NIPdsoBtsvBcSbyWNImpC0fgsWM6NiApk+dkgHmVpnvZ+xdswtbZbYD
56cArIyYi+ZpH7NVE6ilsvejO3vmyIDm7SCIZSPXkxWP7lNDaQ/mqWtXYOIgEVDEgWgmUbiEmnW
8kZjhQTio1h4BH74Xux/uBPmh5gwYM1myp4zLcKe+E2QDi5SqypWLK0yTMQV/6nbd0kIOrmdaS2
7Xn4GDI4
X-Google-Smtp-Source:
AGHT+IGZsUXSt52km/1r7xB9d39g1BI3rKVqOew8JPbcuvyepXAAKMac45yeCuu0QYSXIjhX2gN8HQ==
X-Received: by 2002:a17:902:c407:b0:215:b45a:6a63 with SMTP id
d9443c01a7336-21614d7e213mr58883275ad.32.1733513355310;
Fri, 06 Dec 2024 11:29:15 -0800 (PST)
From: Pierrick Bouvier <pierrick.bouvier@linaro.org>
To: qemu-devel@nongnu.org
Cc: Peter Maydell <peter.maydell@linaro.org>,
=?UTF-8?q?Alex=20Benn=C3=A9e?= <alex.bennee@linaro.org>,
Richard Henderson <richard.henderson@linaro.org>, qemu-block@nongnu.org,
philmd@linaro.org, Paolo Bonzini <pbonzini@redhat.com>,
Fabiano Rosas <farosas@suse.de>,
Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>,
=?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= <berrange@redhat.com>,
Markus Armbruster <armbru@redhat.com>, qemu-arm@nongnu.org,
Michael Roth <michael.roth@amd.com>, Peter Xu <peterx@redhat.com>,
gustavo.romero@linaro.org, Yuri Benditovich <yuri.benditovich@daynix.com>,
Eric Blake <eblake@redhat.com>, Andrew Melnychenko <andrew@daynix.com>,
Konstantin Kostiuk <kkostiuk@redhat.com>, Kevin Wolf <kwolf@redhat.com>,
Thomas Huth <thuth@redhat.com>, Jason Wang <jasowang@redhat.com>,
manos.pitsidianakis@linaro.org,
Pierrick Bouvier <pierrick.bouvier@linaro.org>
Subject: [PATCH v3 6/6] docs: add a glossary
Date: Fri, 6 Dec 2024 11:29:00 -0800
Message-Id: <20241206192900.3893118-7-pierrick.bouvier@linaro.org>
X-Mailer: git-send-email 2.39.5
In-Reply-To: <20241206192900.3893118-1-pierrick.bouvier@linaro.org>
References: <20241206192900.3893118-1-pierrick.bouvier@linaro.org>
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17
as permitted sender) client-ip=209.51.188.17;
envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org;
helo=lists.gnu.org;
Received-SPF: pass client-ip=2607:f8b0:4864:20::432;
envelope-from=pierrick.bouvier@linaro.org; helo=mail-pf1-x432.google.com
X-Spam_score_int: -19
X-Spam_score: -2.0
X-Spam_bar: --
X-Spam_report: (-2.0 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1,
DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1,
RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001,
URIBL_SBL_A=0.1 autolearn=unavailable autolearn_force=no
X-Spam_action: no action
X-BeenThere: qemu-devel@nongnu.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: <qemu-devel.nongnu.org>
List-Unsubscribe: <https://lists.nongnu.org/mailman/options/qemu-devel>,
<mailto:qemu-devel-request@nongnu.org?subject=unsubscribe>
List-Archive: <https://lists.nongnu.org/archive/html/qemu-devel>
List-Post: <mailto:qemu-devel@nongnu.org>
List-Help: <mailto:qemu-devel-request@nongnu.org?subject=help>
List-Subscribe: <https://lists.nongnu.org/mailman/listinfo/qemu-devel>,
<mailto:qemu-devel-request@nongnu.org?subject=subscribe>
Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org
Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org
X-ZohoMail-DKIM: pass (identity @linaro.org)
X-ZM-MESSAGEID: 1733513426448116600
Content-Type: text/plain; charset="utf-8"
Signed-off-by: Pierrick Bouvier <pierrick.bouvier@linaro.org>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
---
docs/devel/control-flow-integrity.rst | 2 +
docs/devel/multi-thread-tcg.rst | 2 +
docs/glossary.rst | 280 ++++++++++++++++++++++++++
docs/index.rst | 1 +
docs/system/arm/virt.rst | 2 +
docs/system/images.rst | 2 +
docs/tools/qemu-nbd.rst | 2 +
7 files changed, 291 insertions(+)
create mode 100644 docs/glossary.rst
diff --git a/docs/devel/control-flow-integrity.rst b/docs/devel/control-flo=
w-integrity.rst
index e6b73a4fe1a..3d5702fa4cc 100644
--- a/docs/devel/control-flow-integrity.rst
+++ b/docs/devel/control-flow-integrity.rst
@@ -1,3 +1,5 @@
+.. _cfi:
+
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D
Control-Flow Integrity (CFI)
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D
diff --git a/docs/devel/multi-thread-tcg.rst b/docs/devel/multi-thread-tcg.=
rst
index d706c27ea74..7fd0a07633d 100644
--- a/docs/devel/multi-thread-tcg.rst
+++ b/docs/devel/multi-thread-tcg.rst
@@ -4,6 +4,8 @@
This work is licensed under the terms of the GNU GPL, version 2 or
later. See the COPYING file in the top-level directory.
=20
+.. _mttcg:
+
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
Multi-threaded TCG
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
diff --git a/docs/glossary.rst b/docs/glossary.rst
new file mode 100644
index 00000000000..693d9855dd1
--- /dev/null
+++ b/docs/glossary.rst
@@ -0,0 +1,280 @@
+.. _Glossary:
+
+--------
+Glossary
+--------
+
+This section of the manual presents brief definitions of acronyms and term=
s used
+by QEMU developers.
+
+Accelerator
+-----------
+
+A specific API used to accelerate execution of guest instructions. It can =
be
+hardware-based, through a virtualization API provided by the host OS (kvm,=
hvf,
+whpx, ...), or software-based (tcg). See this description of `supported
+accelerators<Accelerators>`.
+
+Board
+-----
+
+Another name for :ref:`machine`.
+
+Block
+-----
+
+Block drivers are the available `disk formats and front-ends
+<block-drivers>` available, and block devices `(see Block device section on
+options page)<sec_005finvocation>` are using them to implement disks for a
+virtual machine.
+
+CFI
+---
+
+Control Flow Integrity is a hardening technique used to prevent exploits
+targeting QEMU by detecting unexpected branches during execution. QEMU `ac=
tively
+supports<cfi>` being compiled with CFI enabled.
+
+Device
+------
+
+In QEMU, a device is a piece of hardware visible to the guest. Examples in=
clude
+UARTs, PCI controllers, PCI cards, VGA controllers, and many more.
+
+QEMU is able to emulate a CPU, and all the hardware interacting with it,
+including `many devices<device-emulation>`. When QEMU runs a virtual machi=
ne
+using a hardware-based accelerator, it is responsible for emulating, using
+software, all devices.
+
+EDK2
+----
+
+EDK2, as known as `TianoCore <https://www.tianocore.org/>`_, is an open so=
urce
+implementation of UEFI standard. QEMU virtual machines that boot a UEFI fi=
rmware
+usually use EDK2.
+
+gdbstub
+-------
+
+QEMU implements a `gdb server <GDB usage>`, allowing gdb to attach to it a=
nd
+debug a running virtual machine, or a program in user-mode. This allows
+debugging the guest code that is running inside QEMU.
+
+glib2
+-----
+
+`GLib2 <https://docs.gtk.org/glib/>`_ is one of the most important librari=
es we
+are using through the codebase. It provides many data structures, macros, =
string
+and thread utilities and portable functions across different OS. It's requ=
ired
+to build QEMU.
+
+Guest agent
+-----------
+
+The `QEMU Guest Agent <qemu-ga>` is a daemon intended to be run within vir=
tual
+machines. It provides various services to help QEMU to interact with it.
+
+.. _guest:
+
+Guest
+-----
+
+Guest is the architecture of the virtual machine, which is emulated.
+See also :ref:`host`.
+
+Sometimes this is called the :ref:`target` architecture, but that term
+can be ambiguous.
+
+.. _host:
+
+Host
+----
+
+Host is the architecture on which QEMU is running on, which is native.
+See also :ref:`guest`.
+
+Hypervisor
+----------
+
+The formal definition of an hypervisor is a program or API than can be use=
d to
+manage a virtual machine. QEMU is a virtualizer, that interacts with vario=
us
+hypervisors.
+
+In the context of QEMU, an hypervisor is an API, provided by the Host OS,
+allowing to execute virtual machines. Linux implementation is KVM (and sup=
ports
+Xen as well). For MacOS, it's HVF. Windows defines WHPX. And NetBSD provid=
es
+NVMM.
+
+.. _machine:
+
+Machine
+-------
+
+QEMU's system emulation models many different types of hardware. A machine=
model
+(sometimes called a board model) is the model of a complete virtual system=
with
+RAM, one or more CPUs, and various devices. It can be selected with the op=
tion
+``-machine`` of qemu-system. Our machine models can be found on this `page
+<system-targets-ref>`.
+
+Migration
+---------
+
+QEMU can save and restore the execution of a virtual machine between diffe=
rent
+host systems. This is provided by the `Migration framework<migration>`.
+
+NBD
+---
+
+The `QEMU Network Block Device server <qemu-nbd>` is a tool that can be us=
ed to
+mount and access QEMU images, providing functionality similar to a loop de=
vice.
+
+Mailing List
+------------
+
+This is `where <https://wiki.qemu.org/Contribute/MailingLists>`_ all the
+development happens! Changes are posted as series, that all developers can
+review and share feedback for.
+
+For reporting issues, our `GitLab
+<https://gitlab.com/qemu-project/qemu/-/issues>`_ tracker is the best plac=
e.
+
+.. _softmmu:
+
+MMU / softmmu
+-------------
+
+The Memory Management Unit is responsible for translating virtual addresse=
s to
+physical addresses and managing memory protection. QEMU system mode is nam=
ed
+"softmmu" precisely because it implements this in software, including a TLB
+(Translation lookaside buffer), for the guest virtual machine.
+
+QEMU user-mode does not implement a full software MMU, but "simply" transl=
ates
+virtual addresses by adding a specific offset, and relying on host MMU/OS
+instead.
+
+Monitor / QMP / HMP
+-------------------
+
+The `QEMU Monitor <QEMU monitor>` is a text interface which can be used to=
interact
+with a running virtual machine.
+
+QMP stands for QEMU Monitor Protocol and is a json based interface.
+HMP stands for Human Monitor Protocol and is a set of text commands availa=
ble
+for users who prefer natural language to json.
+
+MTTCG
+-----
+
+Multiple CPU support was first implemented using a round-robin algorithm
+running on a single thread. Later on, `Multi-threaded TCG <mttcg>` was dev=
eloped
+to benefit from multiple cores to speed up execution.
+
+Plugins
+-------
+
+`TCG Plugins <TCG Plugins>` is an API used to instrument guest code, in sy=
stem
+and user mode. The end goal is to have a similar set of functionality comp=
ared
+to `DynamoRIO <https://dynamorio.org/>`_ or `valgrind <https://valgrind.or=
g/>`_.
+
+One key advantage of QEMU plugins is that they can be used to perform
+architecture agnostic instrumentation.
+
+Patchew
+-------
+
+`Patchew <https://patchew.org/QEMU/>`_ is a website that tracks patches on=
the
+Mailing List.
+
+PR
+--
+
+Once a series is reviewed and accepted by a subsystem maintainer, it will =
be
+included in a PR (Pull Request) that the project maintainer will merge int=
o QEMU
+main branch, after running tests.
+
+The QEMU project doesn't currently expect most developers to directly subm=
it
+pull requests.
+
+QCOW2
+-----
+
+QEMU Copy On Write is a disk format developed by QEMU. It provides transpa=
rent
+compression, automatic extension, and many other advantages over a raw ima=
ge.
+
+qcow2 is the recommended format to use.
+
+QEMU
+----
+
+`QEMU (Quick Emulator) <https://www.qemu.org/>`_ is a generic and open sou=
rce
+machine emulator and virtualizer.
+
+QOM
+---
+
+`QEMU Object Model <qom>` is an object oriented API used to define various
+devices and hardware in the QEMU codebase.
+
+Record/replay
+-------------
+
+`Record/replay <replay>` is a feature of QEMU allowing to have a determini=
stic
+and reproducible execution of a virtual machine.
+
+Rust
+----
+
+`A new programming language <https://www.rust-lang.org/>`_, memory safe by
+default. There is a work in progress to integrate it in QEMU codebase for
+various subsystems.
+
+System mode
+-----------
+
+QEMU System mode provides a virtual model of an entire machine (CPU, memor=
y and
+emulated devices) to run a guest OS. In this mode the CPU may be fully emu=
lated,
+or it may work with a hypervisor such as KVM, Xen or Hypervisor.Framework =
to
+allow the guest to run directly on the host CPU.
+
+QEMU System mode is called :ref:`softmmu <softmmu>` as well.
+
+.. _target:
+
+Target
+------
+
+The term "target" can be ambiguous. In most places in QEMU it is used as a
+synonym for :ref:`guest`. For example the code for emulating Arm CPUs is in
+``target/arm/``. However in the :ref:`TCG subsystem <tcg>` "target" refers=
to the
+architecture which QEMU is running on, i.e. the :ref:`host`.
+
+TCG
+---
+
+TCG is the QEMU `Tiny Code Generator <tcg>`. It is the JIT (just-in-time)
+compiler we use to emulate a guest CPU in software.
+
+It is one of the accelerators supported by QEMU, and supports a lot of
+guest/host architectures.
+
+User mode
+---------
+
+QEMU User mode can launch processes compiled for one CPU on another CPU. I=
n this
+mode the CPU is always emulated. In this mode, QEMU translate system calls=
from
+guest to host kernel. It is available for Linux and BSD.
+
+VirtIO
+------
+
+VirtIO is an open standard used to define and implement virtual devices wi=
th a
+minimal overhead, defining a set of data structures and hypercalls (simila=
r to
+system calls, but targeting an hypervisor, which happens to be QEMU in our
+case). It's designed to be more efficient than emulating a real device, by
+minimizing the amount of interactions between a guest VM and its hyperviso=
r.
+
+vhost-user
+----------
+
+`Vhost-user <vhost_user>` is an interface used to implement VirtIO devices
+outside of QEMU itself.
diff --git a/docs/index.rst b/docs/index.rst
index 78285ebd6a4..5665de85cab 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -20,3 +20,4 @@ Welcome to QEMU's documentation!
interop/index
specs/index
devel/index
+ glossary
diff --git a/docs/system/arm/virt.rst b/docs/system/arm/virt.rst
index e67e7f0f7c5..11ceb898264 100644
--- a/docs/system/arm/virt.rst
+++ b/docs/system/arm/virt.rst
@@ -1,3 +1,5 @@
+.. _arm-virt:
+
'virt' generic virtual platform (``virt``)
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
=20
diff --git a/docs/system/images.rst b/docs/system/images.rst
index d000bd6b6f1..a5551173c97 100644
--- a/docs/system/images.rst
+++ b/docs/system/images.rst
@@ -82,4 +82,6 @@ VM snapshots currently have the following known limitatio=
ns:
- A few device drivers still have incomplete snapshot support so their
state is not saved or restored properly (in particular USB).
=20
+.. _block-drivers:
+
.. include:: qemu-block-drivers.rst.inc
diff --git a/docs/tools/qemu-nbd.rst b/docs/tools/qemu-nbd.rst
index 329f44d9895..4f21b7904ac 100644
--- a/docs/tools/qemu-nbd.rst
+++ b/docs/tools/qemu-nbd.rst
@@ -1,3 +1,5 @@
+.. _qemu-nbd:
+
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
QEMU Disk Network Block Device Server
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--=20
2.39.5