From patchwork Tue Jan 16 10:48:08 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Alex_Benn=C3=A9e?= X-Patchwork-Id: 763027 Delivered-To: patch@linaro.org Received: by 2002:a5d:5903:0:b0:337:62d3:c6d5 with SMTP id v3csp1551369wrd; Tue, 16 Jan 2024 02:51:26 -0800 (PST) X-Google-Smtp-Source: AGHT+IHHUqvUcwYl50mOux6ppOQUfaYbG1erEAEFIFdEHteUtUgAf+Z06vpPTO9oEjOtmn39ueR3 X-Received: by 2002:a05:690c:b93:b0:5ff:2ee8:1b42 with SMTP id ck19-20020a05690c0b9300b005ff2ee81b42mr2348601ywb.87.1705402285802; Tue, 16 Jan 2024 02:51:25 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1705402285; cv=none; d=google.com; s=arc-20160816; b=i5hCM1TG48dbUgTWFZlYyptp4PM1k6sBHrGHk5HNom4Q1XpfbibwToh8m1Re0FjloV VPytajCvnqbZnphLLAvLOq9+Y+Bm/Yrcng6Fr80UroARjvDRTBxnLiZa6zYzUGx+tXQJ gW8BSYM7lGkrYEe/38MqYyFF0uYySoUKkS6HFUxsad+r5tTXZRGSE75Bl8XmNKEraoHL O07czagxZ4KYEDJez3tmOLFkm6thuZZCfp9elNWIdJZ9Zt+xVzqVC/HcNvXz8Q2RTQSN TzIcmerZwsAn55U/vfMb4jDx8PBgMoR8zwHlvSQbll3sZJTANe5DZkweON0fRugULkPe rf/w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=zet1F0IXZblv1/B9heIoJ6sflAFrB9ZoscsrKiRyGys=; fh=oCnRHZ0Je3Vi4Qy937AloZ7NAz8BqhJoZWGWitVkkPg=; b=tSzNLk0OEG04McE29rH1ZJJ+9/P4YpqJYmQe/glY+DBP2uiqV8b+Xav56QxhE3VF04 PYoXLnhBCU9c3YRYQu6hhFknxTpUbcML835X+Rv0erGcSU5FUzlK2X3W8XjCn0GDkUFW NQQ6fN273dfR40r8MQ3iDytSS8xmbr7XAsC3/jvqrySxfk0pzckcJ0O6wKHS1cAOM1XW 9m80zbuP9Qsvw3IhEi3pyiG7AAU7sSXyCdD1g7X1qE2dah0RJRoFJ0t5e/4uZp1Um22y kDaB/AL0PiwckpJR/ZMZzSfq+tqwoG3iIWRLLkodFFIlL4P+ef0ilRIvVfyMvTgPiNRL lIPg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=bd3ZZFM6; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id t11-20020a05620a450b00b007832e5a7226si10031564qkp.276.2024.01.16.02.51.25 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Tue, 16 Jan 2024 02:51:25 -0800 (PST) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=bd3ZZFM6; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rPgzu-0002cl-4d; Tue, 16 Jan 2024 05:48:46 -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 ) id 1rPgzg-0002OR-ST for qemu-devel@nongnu.org; Tue, 16 Jan 2024 05:48:33 -0500 Received: from mail-wm1-x335.google.com ([2a00:1450:4864:20::335]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rPgzb-0007GV-KN for qemu-devel@nongnu.org; Tue, 16 Jan 2024 05:48:31 -0500 Received: by mail-wm1-x335.google.com with SMTP id 5b1f17b1804b1-40e857ce803so3502795e9.0 for ; Tue, 16 Jan 2024 02:48:25 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1705402104; x=1706006904; 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=zet1F0IXZblv1/B9heIoJ6sflAFrB9ZoscsrKiRyGys=; b=bd3ZZFM68Y9JHS8ZTe0L+q42VBR1VjSql3GqlekoW/Bdyt64fXsZrmHFi/2kgUs3gJ ea0H8N2PJJnBaufdU/lGsYTWtFnpzSAXKMRm7y7Xw6ostVrf87yHS1Q8QK7zxVRO3B45 a6hOv3l1hK4r1eDdqbfXexLIlbxSftnonNPfYvMKnOkEOp3G3QNa9yG51BqJpfepm3d4 ZwzetOmZW6E29VKUhq9AU8ayBTIl+Gng4XFPY4Z0kB9M2ZsdyQgZxX83nuFzi4IPH6HL N+/li1eHj5l1us/3XZJ3GjFm2NOJChJLuSITlYONlai3zCreEf2huni7IkQLNRnMZc+7 HxNQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1705402104; x=1706006904; 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=zet1F0IXZblv1/B9heIoJ6sflAFrB9ZoscsrKiRyGys=; b=X8WuWg6lbCnOtPfrZq5AHKAEvNUs6iCua1YsqGdvLUr3XYsUo5C8GkKjw5BWkjOepl CTPzCugN1bZ/KL/EGLd1JXgQZCAMAmyK8BsOHRwxsz77OYHyubUZlup7MNwTlO1HsiNr fGXoOT/BPyKiQTwug7M+dZyK8gcquTuvOoL66fKX6+UxVwMu+6i6DIJt4noH7CJDkQy6 NWxmv3gOWBdfwK+9rzrlSrZz3gJR1FMy9ZfkwxldUUtT9/MhTGT58ruqSiVVAK8Ei3VW Gc3qD7mbjXswb3CSC4zDo8S+RbLjEGH49fpxyNo+0jaEoa1EF/ts8W4lueW2srAHpVU/ 2uCQ== X-Gm-Message-State: AOJu0YyLHA9nK43ODGxWeVCVk0ojlytDBC9Jd9Ckd1J/ZuOzJikVmmvb OZbJ/2p5HwM2ZOlPsS2QCtKeWZNoTJsu1A== X-Received: by 2002:a05:600c:524a:b0:40e:4afe:12eb with SMTP id fc10-20020a05600c524a00b0040e4afe12ebmr3354191wmb.188.1705402104482; Tue, 16 Jan 2024 02:48:24 -0800 (PST) Received: from draig.lan ([85.9.250.243]) by smtp.gmail.com with ESMTPSA id fk4-20020a05600c0cc400b0040e7efb1ff2sm4562472wmb.37.2024.01.16.02.48.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 16 Jan 2024 02:48:22 -0800 (PST) Received: from draig.lan (localhost [IPv6:::1]) by draig.lan (Postfix) with ESMTP id 7D4E75F933; Tue, 16 Jan 2024 10:48:11 +0000 (GMT) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: =?utf-8?q?Alex_Benn=C3=A9e?= , Pierrick Bouvier , =?utf-8?q?Philippe_Mathieu-?= =?utf-8?q?Daud=C3=A9?= , Richard Henderson , Paolo Bonzini , Alexandre Iooss , Mahmoud Mandour Subject: [PULL 21/22] docs/devel: lift example and plugin API sections up Date: Tue, 16 Jan 2024 10:48:08 +0000 Message-Id: <20240116104809.250076-22-alex.bennee@linaro.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20240116104809.250076-1-alex.bennee@linaro.org> References: <20240116104809.250076-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::335; envelope-from=alex.bennee@linaro.org; helo=mail-wm1-x335.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, T_SCC_BODY_TEXT_LINE=-0.01 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: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: qemu-devel-bounces+patch=linaro.org@nongnu.org This makes them a bit more visible in the TCG emulation menu rather than hiding them away bellow the ToC limit. Message-Id: <20240103173349.398526-43-alex.bennee@linaro.org> Reviewed-by: Pierrick Bouvier Signed-off-by: Alex Bennée Reviewed-by: Philippe Mathieu-Daudé diff --git a/docs/devel/tcg-plugins.rst b/docs/devel/tcg-plugins.rst index fa7421279f5..535a74684c5 100644 --- a/docs/devel/tcg-plugins.rst +++ b/docs/devel/tcg-plugins.rst @@ -143,7 +143,7 @@ requested. The plugin isn't completely uninstalled until the safe work has executed while all vCPUs are quiescent. Example Plugins ---------------- +=============== There are a number of plugins included with QEMU and you are encouraged to contribute your own plugins plugins upstream. There is a @@ -591,8 +591,8 @@ The plugin has a number of arguments, all of them are optional: configuration arguments implies ``l2=on``. (default: N = 2097152 (2MB), B = 64, A = 16) -API ---- +Plugin API +========== The following API is generated from the inline documentation in ``include/qemu/qemu-plugin.h``. Please ensure any updates to the API