From patchwork Fri Mar 12 17:28:10 2021 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: 398686 Delivered-To: patch@linaro.org Received: by 2002:a02:8562:0:0:0:0:0 with SMTP id g89csp1421391jai; Fri, 12 Mar 2021 10:20:05 -0800 (PST) X-Google-Smtp-Source: ABdhPJy7tOuN+B8CuvXS2uFEwxOdPqYWnX/R7otbqqvldfVCsTHSzblsYoKLHLWRt4P8JnJVeGR5 X-Received: by 2002:a92:5411:: with SMTP id i17mr3615755ilb.22.1615573205238; Fri, 12 Mar 2021 10:20:05 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1615573205; cv=none; d=google.com; s=arc-20160816; b=XiZab7rJ91QMhCsuL4AfI2HVWSQ+WYHN217gOg0jZQIiKeSocbgAfy69opFftyI9U9 40m8mWDZ997NOloa/D8fVJcCiAAGKMM8n8oXU0andz2xseZQHV82poifP7jjGG5VDKqQ uTDbVFP/oPQ1ReuPwM0yUr0ZQcwPil67O9q+d7+C4q5OOB5t2zQcv3xmH3e+rJ125Dh5 X+YHOT5IMHXq8jgVAa7N91X9+M1cPNK/xZQtzO/gMg4GFagfbNWTOqjYddMZoUJuvRr3 LeAk/0GH9YMW1XiWoNbKJH0r7peTJgEzpW4rpfaUip50KiWtdIbkINZAZZPMFA2HS7ib 6CHg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc: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:to:from :dkim-signature; bh=Tgg01WFzYZWxtwMF3RzuONdmzCofqm4lYuJbp66nklY=; b=MjHHAVVs5XywvezWYETFE13H3rh8R0Fvjwre4JdLaUAav1nyEeJS+t5b6uYchhEYRa BCzaTQ/wOke69U6uHGlBpzuWdMOdLZbh3ib7/ww5NSrRs8S00ozhlRlinAAENfmsU+dA Oi42fOdEOgGq6SmnpXllfhEhNVB5wNIRuKKfAOlj4taBidXdaaY4QICBoP3VL1w9OMfS s9wvCvzCfQ+/zq3mY4RBeJ3Rr2rztxYSNBv38FbuLHiGUW35Ob55vseiUqpakpMOIG6h 0YYptcjbGA1aFyFyI1SAARg5WiX75Q64QEgQSXOnh28osSwi1ehdiBcPHpUdMLZOVMQp aGvA== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=e9U5fnct; 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=fail (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 q126si6198043iod.60.2021.03.12.10.20.05 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Fri, 12 Mar 2021 10:20:05 -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=fail header.i=@linaro.org header.s=google header.b=e9U5fnct; 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=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1]:47754 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lKmOK-0000DN-ML for patch@linaro.org; Fri, 12 Mar 2021 13:20:04 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:59368) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lKlae-00042K-FT for qemu-devel@nongnu.org; Fri, 12 Mar 2021 12:28:44 -0500 Received: from mail-ej1-x632.google.com ([2a00:1450:4864:20::632]:36892) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lKlaN-0002C7-PJ for qemu-devel@nongnu.org; Fri, 12 Mar 2021 12:28:44 -0500 Received: by mail-ej1-x632.google.com with SMTP id bm21so54815017ejb.4 for ; Fri, 12 Mar 2021 09:28:27 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=Tgg01WFzYZWxtwMF3RzuONdmzCofqm4lYuJbp66nklY=; b=e9U5fnctqAaxTymmQbwTZNVKbCIAQrVQxTID9Ip8sWTCNHES88Sea+6VcDWvDJEsR3 UZYgek/HGQkqDDznOn5mHiHFGWO5d9wJfBaI8ZApBhwbSRRDlkuDML9tlRLC9x+wUlbn p/DtguzS2vnjtIyOIkRlCjJr6mNvQJE8sTwJYRKMvAePIPpKMpziIrUGo3V/GH9r30pw glfUQAXLHByXsIdN974w12G+luUCrcxzYH89uGvL6om5CV3hNQEYZ608ZLGMq7FuB2Gv 06TuIZQWo4CY70EES/udU9AkziZgISgyOam4F3BNtGKf7QknEqi4wX/aNve73n3U5bbt bZrQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=Tgg01WFzYZWxtwMF3RzuONdmzCofqm4lYuJbp66nklY=; b=GjuAIoB8Hqet/pog0EDuCE7Sqmz1hxmtktVFbHrCk9Xwj/T+mIwcwoq6VKmP5P6S7d 34kBV9G9hzpmy9MGpqlKfVWiikNY7nGUez3tmPz+PgQ39QAlBHgK8E/HtRazm2kNfe9e kuVGvZRTlUyDEVZ4L2WPsYBt5WQHHlIHaedCOUJWv7eWw6q0m1/T7K3IoJT0SIMKlISr TYbMPhTgALLYvnPNj3w+3xd5xdC1h7M1U8+5NKcujIhKo3BPEYzC3NkFDO9mR2LBjIVx usDV2IumRYDsaC2lXZimPngmPt0Zh/iOppcXmMHaPnoyUnP+AsMME5jDbisko8kOjrey PdPQ== X-Gm-Message-State: AOAM531psw29jMDdpsN5kA8xA506E9DQkuIPTtHj6kCnunBTwOlViaWV G0euiBP1loeQwBB6WxzzcssAUQ== X-Received: by 2002:a17:907:d8a:: with SMTP id go10mr9892867ejc.46.1615570106553; Fri, 12 Mar 2021 09:28:26 -0800 (PST) Received: from zen.linaroharston ([51.148.130.216]) by smtp.gmail.com with ESMTPSA id rs24sm3108929ejb.75.2021.03.12.09.28.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 12 Mar 2021 09:28:23 -0800 (PST) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 0155C1FF8F; Fri, 12 Mar 2021 17:28:22 +0000 (GMT) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Subject: [PATCH v1 03/14] docs/devel: include the plugin API information from the headers Date: Fri, 12 Mar 2021 17:28:10 +0000 Message-Id: <20210312172821.31647-4-alex.bennee@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210312172821.31647-1-alex.bennee@linaro.org> References: <20210312172821.31647-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::632; envelope-from=alex.bennee@linaro.org; helo=mail-ej1-x632.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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: robhenry@microsoft.com, mahmoudabdalghany@outlook.com, aaron@os.amperecomputing.com, cota@braap.org, kuhn.chenqun@huawei.com, =?utf-8?q?Alex_Benn=C3=A9e?= Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" We have kerneldoc tags for the headers so we might as well extract them into our developer documentation whilst we are at it. Signed-off-by: Alex Bennée --- docs/devel/tcg-plugins.rst | 5 +++++ 1 file changed, 5 insertions(+) -- 2.20.1 Reviewed-by: Aaron Lindsay diff --git a/docs/devel/tcg-plugins.rst b/docs/devel/tcg-plugins.rst index 39ce86ed96..18c6581d85 100644 --- a/docs/devel/tcg-plugins.rst +++ b/docs/devel/tcg-plugins.rst @@ -63,6 +63,11 @@ valid during the lifetime of the callback so it is important that any information that is needed is extracted during the callback and saved by the plugin. +API +=== + +.. kernel-doc:: include/qemu/qemu-plugin.h + Usage =====