From patchwork Fri Mar 12 17:28:12 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: 398695 Delivered-To: patch@linaro.org Received: by 2002:a02:8562:0:0:0:0:0 with SMTP id g89csp1427672jai; Fri, 12 Mar 2021 10:29:09 -0800 (PST) X-Google-Smtp-Source: ABdhPJzghwH+TBlBG06AfJJkCe0UwbN+31n6RmOMZH1FPSqUnaz+AIAaCSU2g341/J5+8JqWPas2 X-Received: by 2002:a92:d8d1:: with SMTP id l17mr3913656ilo.85.1615573749312; Fri, 12 Mar 2021 10:29:09 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1615573749; cv=none; d=google.com; s=arc-20160816; b=Y4z/8YDluraBMumSTQ83lV8Hrf5zMc6zyDgnxA0qeKiSUq8jgGR8Rj93lgxkf7X6t6 Iti+iVDI2mwt75jkyw5HD/BWRXvh7HLcAOT0eYlHEwCWWhfsJUsEJHHVOdkmgaJdSQW1 muEXIi6UunfBNd5PnDV5ifvZQn++3RgG2/H2eesN1PAk/fUQ53BF3rGXRwgZfoSDcrCL 9x8b2kTTkzj+jBzPR69oZ3CQPY8R81x27e9dDmDYmSk8UD59+GgEnjRf2HUe6DT5VVnP Rmr0LG2Ta58m+NDMBqlVa72uYhqq4ZMGYqIvOrbsnSqBvOMkJC5iMMnuv9tgAOI7QnP1 MjJg== 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=JlkkTcluzTbtq/zjZUoz2AwI7NG2npDobHU+H6XFiEM=; b=mDIuqBbkKTWSnXMZoaXYB9XpRBYsGASrbw8XQ2NqMeWm7FTaXIGHVC/WyEY3OYtWP7 LPlSOkxNPWXnxpbuSgITfv9oisIGEaS7dDMyomeR8WwHIOPBlQM5EdiM822dMC6MdkXZ iTpQScTUoJuCXpazY22dSp1HQOwh3jN0neUzo/GLe2PAG57w8/W8joB6J8gO5jua0WaY W8TM8W27gUCTD8H26JNv4UshNNDHcUqj9p4kCwQrSJJLp4hStFBuV7mvDRVj1DCZSkJO Rjq3A7fByNae/DjYW9fCVNXpiEsvF9tfO67bPqNf/w23vIMT6Sd+EahqkxTqkdZfLs3g Uz0g== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=oxX0OTdm; 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 h14si5507422ilo.27.2021.03.12.10.29.09 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Fri, 12 Mar 2021 10:29:09 -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=oxX0OTdm; 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]:47332 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lKmX6-0004y7-Lh for patch@linaro.org; Fri, 12 Mar 2021 13:29:08 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:59408) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lKlaf-00045p-W4 for qemu-devel@nongnu.org; Fri, 12 Mar 2021 12:28:46 -0500 Received: from mail-ej1-x62d.google.com ([2a00:1450:4864:20::62d]:46851) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lKlaR-0002Cq-42 for qemu-devel@nongnu.org; Fri, 12 Mar 2021 12:28:45 -0500 Received: by mail-ej1-x62d.google.com with SMTP id r17so54796452ejy.13 for ; Fri, 12 Mar 2021 09:28:30 -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=JlkkTcluzTbtq/zjZUoz2AwI7NG2npDobHU+H6XFiEM=; b=oxX0OTdmFfrpINhW2urx0EPuu+G/u7rN2H9A2ORXDRLO+yUbasiiItTY9Jj2C4wKa+ SX3znl0hG0vJRJGovpjDB6PzASKQgBpZ8WKZWvvpXz70NxlSl5PmYMod0owQSQXngyJ5 AAb3wropu/WKEQq2HXyjsz88ZOmAZKIQJtC/kPK4upiEZ4Xm86hvaJY9CH19hQRobXS2 Pak6ZLE7WOIEo0/eB1KYrPXO/2dPqwtjmO4VmALockPYekeVz0zRJXNa+jZuX1x7xQWQ ES2rSFDf3L0bm+aQRTPVl959wRtubyCDO2mWLiXqjfPdt4lWujOCAXlvXQyByS/wc+YQ mTHg== 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=JlkkTcluzTbtq/zjZUoz2AwI7NG2npDobHU+H6XFiEM=; b=FfwOHPIjGw5XUWwBy8lJ/Qq0ave9kGHpDbD9ztqI0Me8QyNC9K1b1AevOk/DucYADf AFu5EosD6+HxbDpfuWVwsh8K6lsM9pe5QW3FFSptoG/Cxvr6mNNwmQ3ljKUYu0T7kkER UH6oLTHSMsHXXVUEk4ZTpDMMALgseUqK1/wLuLQXRlcnEX2etCrV2QXQICKpap/Y6Nc2 kCFqqccqvLo1HP3oDCb0+fiHCm9Tc403FhUYp6fV9+tWBByZ4FPUqsmPujQxsIgZi9rp SRma2U4H2GyBX2S9wOKDFHzfER7qm3iS3wQY5TlvCtUhRA22Xz2pPtaqEVdtsa5G+qrJ /PQw== X-Gm-Message-State: AOAM530lN3PN8I0ThdLTHK/+rg1UVwib9lIVAdykFjTqwoQYwTanWP0s DRORxJQ04p5LNLtezUnFEya5ww== X-Received: by 2002:a17:906:3488:: with SMTP id g8mr9507564ejb.282.1615570109812; Fri, 12 Mar 2021 09:28:29 -0800 (PST) Received: from zen.linaroharston ([51.148.130.216]) by smtp.gmail.com with ESMTPSA id w24sm3393605edt.44.2021.03.12.09.28.23 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 12 Mar 2021 09:28:27 -0800 (PST) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 32C031FF91; 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 05/14] plugins: cleanup kernel-doc for qemu_plugin_install Date: Fri, 12 Mar 2021 17:28:12 +0000 Message-Id: <20210312172821.31647-6-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::62d; envelope-from=alex.bennee@linaro.org; helo=mail-ej1-x62d.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" kernel-doc doesn't like multiple Note sections. Also add an explicit Return. Signed-off-by: Alex Bennée --- include/qemu/qemu-plugin.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) -- 2.20.1 Reviewed-by: Aaron Lindsay diff --git a/include/qemu/qemu-plugin.h b/include/qemu/qemu-plugin.h index 4b84c6c293..ac1bb318da 100644 --- a/include/qemu/qemu-plugin.h +++ b/include/qemu/qemu-plugin.h @@ -85,15 +85,15 @@ typedef struct qemu_info_t { * @argc: number of arguments * @argv: array of arguments (@argc elements) * - * All plugins must export this symbol. - * - * Note: Calling qemu_plugin_uninstall() from this function is a bug. To raise - * an error during install, return !0. + * All plugins must export this symbol which is called when the plugin + * is first loaded. Calling qemu_plugin_uninstall() from this function + * is a bug. * * Note: @info is only live during the call. Copy any information we - * want to keep. + * want to keep. @argv remains valid throughout the lifetime of the + * loaded plugin. * - * Note: @argv remains valid throughout the lifetime of the loaded plugin. + * Return: 0 on successful loading, !0 for an error. */ QEMU_PLUGIN_EXPORT int qemu_plugin_install(qemu_plugin_id_t id, const qemu_info_t *info,