From patchwork Wed Mar 24 14:30:01 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: 407817 Delivered-To: patch@linaro.org Received: by 2002:a02:8562:0:0:0:0:0 with SMTP id g89csp462508jai; Wed, 24 Mar 2021 07:31:01 -0700 (PDT) X-Google-Smtp-Source: ABdhPJwEaIFevNsv3SLZnwPZIyLANC/mq9+CiuRKIswhJE2VztgtXSr31x8nfEQUeINnTKFdxJYm X-Received: by 2002:a5e:c809:: with SMTP id y9mr2755130iol.192.1616596261656; Wed, 24 Mar 2021 07:31:01 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1616596261; cv=none; d=google.com; s=arc-20160816; b=OIh85dq79+oqb62VKGwgZuL2DEyUwKLLod7y3+YtxsqY5Mk8bcCJSiyeYpK5ad9FQB OqE31oS40bepQxiyXWw6/1hLz4wN6ecrdrSJzyDyo4LQxhOu+8je0oqxUXORue5AvdaR g0N15o53ogRqoIer8GFXkDKMSVbc5c5mNuYrqX+hY6PO5h/jpvvuQPsIY5z3YfcDKPcz h6Rol9bt41nFggjs1L9PIuUJpovMxNDiVhd5joaN6Z1uybXwyiH/ZfmX3n5PD7nx+7jr 2VFNZlQTg/7OH0QgaHtiTgxg+N9yc0ndLY5p/Fhii90wpY/K5RR77mA3NsGMGlhar5Xw D+VA== 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=LoR6KdJgI9L3QJjbSS34AyLS8mbG6iWvfcan+tzTXxg=; b=W/ECcm0BpKYXurju49lL1MsorcdhulCsNtdu6L73rDy9IXxVfdHH8eK424luRkdGip FenITuk6ZIhUMiZ6XM5k0jDUrz1upM9mIpW4O3w8WwpeJgK8kB4I7Kq/x2cyI49MfX33 t8NEwbeU/7NQt35qZhZMjbDYPAa1SSJANavtbGDcMDK/7uM6a5/m8sD4sHJdt+hxK6TE ECVjwdt2RXV49EeJoXK65AdW0jalsXNuli/ZXJUmAq+byKAcmnDJZYRkDt/t2T8/gQcH D9YHVYzERW0zwD/GiAakmWp2g1HEKXS5TC2n6Xs9pY5Mn9Pijcb8fmKbTadVC1k+iWVh F20w== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=nGw+qVQe; 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 f10si1566990iop.79.2021.03.24.07.31.01 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Wed, 24 Mar 2021 07:31:01 -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=fail header.i=@linaro.org header.s=google header.b=nGw+qVQe; 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]:44200 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lP4XE-0006IL-U5 for patch@linaro.org; Wed, 24 Mar 2021 10:31:00 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:51522) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lP4Wi-0006F1-Tt for qemu-devel@nongnu.org; Wed, 24 Mar 2021 10:30:29 -0400 Received: from mail-wm1-x333.google.com ([2a00:1450:4864:20::333]:41826) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lP4Wh-0007IN-9N for qemu-devel@nongnu.org; Wed, 24 Mar 2021 10:30:28 -0400 Received: by mail-wm1-x333.google.com with SMTP id t5-20020a1c77050000b029010e62cea9deso1334067wmi.0 for ; Wed, 24 Mar 2021 07:30:26 -0700 (PDT) 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=LoR6KdJgI9L3QJjbSS34AyLS8mbG6iWvfcan+tzTXxg=; b=nGw+qVQeuntjzJRrP+ha2+vzGueFH1oxODHuM4U/yBZLNXyiVKr78QaRvWLGaT4s8n 0AKJcv6yyJyzd/VMKC9W0LkkOIQxDhOOcSDrHefwr/PX15hvAf/2jyZRQoywhoq7BkP8 i/gr3TKmyCSrRifhO05CfdBjQf6KYYmuFgXbhj2snLw/UvyVoqxNKB+b8xA23+Kg1SXW EBKeF5LYiHT7PqrqqG/B3d6x/V4U+mCV6+dlPncPr7KKdHr9ec6unDJN5LNa0et6CtTw 6gP1u46Znqc/cLFDw2UqFHXsEa7WWfsRaZRqytZzEYZ0kE6rmlOEf+1vQw/Wc+QSCUV1 Sx+g== 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=LoR6KdJgI9L3QJjbSS34AyLS8mbG6iWvfcan+tzTXxg=; b=eapeWSPXUw1mpYgkuK3LJTkG5UQgW6SVo0874k/v55+fvfe7WhMwJvtobmoZkj5Jx6 K42YkbA3MnwVHyhoUhWx5860z29YFJw0qkFae3L7yhKDqSsfd0V4Cx9lUANHZcIjFt3o 3a/hRes6EJFYUlW1BCI6cUYabxVe3LjwjVGqa9mP06ESe4geeagIWBG2NkGsyk9W4ize lLEn2j+tP/QSoV+PpmZyNep2tLbp6ylQU/v3dOft/XupMRoc0TiomZmTbw3bCvYVKYem WnZbb/DaNoVy/NdTXQgzAcwRMIglARtGFFVrTKpHAEit9LmnGj87e3fjUp3DcNvOO8Nz UVEQ== X-Gm-Message-State: AOAM5315LA1Yc1E0oYh0ZWCD4jA2etWFYJVwf9bvWDP4jbPs/ee6QAF/ cNGLQaZ4xRVpWmFs+f3E+ZsAAq4Yir2DFOY0 X-Received: by 2002:a7b:cd8f:: with SMTP id y15mr3266788wmj.185.1616596225927; Wed, 24 Mar 2021 07:30:25 -0700 (PDT) Received: from zen.linaroharston ([51.148.130.216]) by smtp.gmail.com with ESMTPSA id j123sm2746986wmb.1.2021.03.24.07.30.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 24 Mar 2021 07:30:22 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id DCE5C1FF8C; Wed, 24 Mar 2021 14:30:21 +0000 (GMT) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: peter.maydell@linaro.org Subject: [PULL 02/22] docs/devel: include the plugin API information from the headers Date: Wed, 24 Mar 2021 14:30:01 +0000 Message-Id: <20210324143021.8560-3-alex.bennee@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210324143021.8560-1-alex.bennee@linaro.org> References: <20210324143021.8560-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::333; envelope-from=alex.bennee@linaro.org; helo=mail-wm1-x333.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: Aaron Lindsay , =?utf-8?q?Alex_Benn?= =?utf-8?b?w6ll?= , qemu-devel@nongnu.org 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 Reviewed-by: Aaron Lindsay Message-Id: <20210323165308.15244-3-alex.bennee@linaro.org> -- 2.20.1 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 =====