From patchwork Tue Oct 4 13:01:22 2022 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: 612240 Delivered-To: patch@linaro.org Received: by 2002:a17:522:c983:b0:460:3032:e3c4 with SMTP id kr3csp180194pvb; Tue, 4 Oct 2022 06:40:23 -0700 (PDT) X-Google-Smtp-Source: AMsMyM7+NHozO3GhhNsWk77RK4xYle70g2DKM/liDWXPL/GOKqGpDtqEHvzkZYTUF1xnpTBdVNKP X-Received: by 2002:a05:6214:29e9:b0:4b1:8d19:a2e8 with SMTP id jv9-20020a05621429e900b004b18d19a2e8mr7439610qvb.46.1664890822850; Tue, 04 Oct 2022 06:40:22 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1664890822; cv=none; d=google.com; s=arc-20160816; b=FY1yYKFIsy36OX8vLrV5PYmbqInH+fAsZ5V00nzPRDbyfWcPTW0YYHc9Sy1a2dms8y e635vE83B+cPxvIUVV/bWYUkrIoE13q2AnTBy/QMeYud4/3vIyJcwAf5G3HxFr8X1UkF d3M5AhT2VBfezVoSf0SQk8vW0lJ0emTBKNPkbIAQG7qLe1MJ2dE1L1JaGgyJYAtFKtPm aDVcYy8WyFTGH5xnZQJRfY2Qi9yvA6UiKqm8ZZf5SljfGagL/mxroJGx7gycVNCIa+l4 ZrsgXB2FjfCfMXoBMwWlOK/FnIyCkMde3dNfmRW4a8qxtUG5KrhdhviJnSRtnAXJsLrX UJ9Q== 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=fhoAi/xjuDoN5VZ/rqThN4w2DfKiDIs3NBYh2o+mArw=; b=Dw/fA5a7MhrXWKRcJFVicgHcRThDeLlZ30j6YT0Z+3LSh8pSsgZ01DiW+l/IDTMnPd XXWcSQPWpQUSVbCNnvOONn6yxKTtSl0stEzxL4vqIcLomZZYTnE0QeKy4DXbLmmk5IOR naTCDC+tWrBccF7jnjiJ9Y8nqCW8hj0+Xlzs25rJpQ4gIGS7h2nQi5GkzJ+poE6V4/8C yjnOARLXdsBdTkvT1bPfEto/6y6ORpK5D/4teLWwc9i1tILWtETeew1fj1r10gI4nV+2 7sRaFS1NqfgbME424NJ0FkAyJpLfjNfqQmHO09XSt+PU4Q+LBnt4h15SJFEm8u/QNzD8 0w2Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=n4rhT87w; 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 u41-20020a05622a19a900b0035ba6adf7d7si5658482qtc.307.2022.10.04.06.40.22 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Tue, 04 Oct 2022 06:40:22 -0700 (PDT) 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=n4rhT87w; 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]:51298 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ofi9l-0007q1-S1 for patch@linaro.org; Tue, 04 Oct 2022 09:40:22 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:54796) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ofhgN-0007NW-6z for qemu-devel@nongnu.org; Tue, 04 Oct 2022 09:09:59 -0400 Received: from mail-wr1-x42e.google.com ([2a00:1450:4864:20::42e]:37561) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ofhgJ-00008P-ON for qemu-devel@nongnu.org; Tue, 04 Oct 2022 09:09:58 -0400 Received: by mail-wr1-x42e.google.com with SMTP id bq9so21256172wrb.4 for ; Tue, 04 Oct 2022 06:09:54 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date; bh=fhoAi/xjuDoN5VZ/rqThN4w2DfKiDIs3NBYh2o+mArw=; b=n4rhT87wP1uUGOIK3z0zbJAnigrr8SZCtlcoGCuIfeqAPmWXHHNEoDR04Blwvj440J pJS/Be3xw9y+ssJsjMcupKA3m9s5QcBqZghwITsom3G64HkWOq0VNQ8jcHRh+FvSGKEy GNyLXMjhGkvHcdUdTY+Mc0ZHNWActa5L+Te2Bl1he/uXEga+6wEN6T2gJc30YqhlKrTG 0MAzFtU5SJgJRFJzOvqeIy6ZSemZoVPeGRwgmTj04vYSJcK6sYBYwS6TaT86+OYriRyb k+W/4kjq2e4qnT1Yn5mKQr2IiVex3+12aX/v1PwgX1WTLyQJ7GZtOkk+5OdklV4mKtDu /XkA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; 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; bh=fhoAi/xjuDoN5VZ/rqThN4w2DfKiDIs3NBYh2o+mArw=; b=sjH1yFfAKjA2lYl52Kx31rXaLQtNCbEwrjXLhktyCMDIz65zuRyWe/qB23ZLWVEd1+ 9nDTKv/MjzbJljXqT8ES3O4k7VkISg0HQ1W80Iy0qyDDU3hg+OPstYOk5+ImhHlqHOBU D7rMPKdZEmcHvXixaQVub3bADVatiuaSLd2WQ7TDOwhuM6JLYXTvmHoJmlTU+pVL4EiR 7Ds0Ze9cNzyD/GwJp87CLqVEaoUlaCOGBs0Q4yyTL6GV4LMXqoyvS7a7lii7t2ub4S+f 0WXbAzZneUTeYgS1vL7VN4PeAEtQMOw/foicPtJsfgaiCXtRV6jPpz3Li24R8YQOIXgs zWrQ== X-Gm-Message-State: ACrzQf2rzmazH7t6wkSpe62WZzecyPcXxU3oBi+x4rP8i6xBxA6IOLjk iWNgZarLvV4ZXF7lEPCGJSYEsg== X-Received: by 2002:adf:f001:0:b0:22e:4f85:3abc with SMTP id j1-20020adff001000000b0022e4f853abcmr1908878wro.107.1664888993590; Tue, 04 Oct 2022 06:09:53 -0700 (PDT) Received: from zen.linaroharston ([185.81.254.11]) by smtp.gmail.com with ESMTPSA id f13-20020a5d568d000000b0022584c82c80sm12446271wrv.19.2022.10.04.06.09.51 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 04 Oct 2022 06:09:51 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 9736B1FFDA; Tue, 4 Oct 2022 14:01:42 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: stefanha@redhat.com, =?utf-8?q?Alex_Benn=C3=A9e?= , =?utf-8?q?Philippe_M?= =?utf-8?q?athieu-Daud=C3=A9?= , Alexandre Iooss , Mahmoud Mandour Subject: [PULL 38/54] docs/devel: move API to end of tcg-plugins.rst Date: Tue, 4 Oct 2022 14:01:22 +0100 Message-Id: <20221004130138.2299307-39-alex.bennee@linaro.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20221004130138.2299307-1-alex.bennee@linaro.org> References: <20221004130138.2299307-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::42e; envelope-from=alex.bennee@linaro.org; helo=mail-wr1-x42e.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: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" The API documentation is quite dry and doesn't flow nicely with the rest of the document. Move it to its own section at the bottom along with a little leader text to remind people to update it. Signed-off-by: Alex Bennée Reviewed-by: Philippe Mathieu-Daudé Message-Id: <20220929114231.583801-39-alex.bennee@linaro.org> diff --git a/docs/devel/tcg-plugins.rst b/docs/devel/tcg-plugins.rst index a6fdde01f8..8b40b2a606 100644 --- a/docs/devel/tcg-plugins.rst +++ b/docs/devel/tcg-plugins.rst @@ -110,11 +110,6 @@ details are opaque to plugins. The plugin is able to query select details of instructions and system configuration only through the exported *qemu_plugin* functions. -API -~~~ - -.. kernel-doc:: include/qemu/qemu-plugin.h - Internals --------- @@ -448,3 +443,13 @@ The plugin has a number of arguments, all of them are optional: associativity of the L2 cache, respectively. Setting any of the L2 configuration arguments implies ``l2=on``. (default: N = 2097152 (2MB), B = 64, A = 16) + +API +--- + +The following API is generated from the inline documentation in +``include/qemu/qemu-plugin.h``. Please ensure any updates to the API +include the full kernel-doc annotations. + +.. kernel-doc:: include/qemu/qemu-plugin.h +