From patchwork Fri Dec 22 05:25:20 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 182541 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:2483:b0:fb:cd0c:d3e with SMTP id q3csp859088dyi; Thu, 21 Dec 2023 21:25:48 -0800 (PST) X-Google-Smtp-Source: AGHT+IFn7LL8ZuXx8tsvj00cVs4cuG9tLd+hQcQwz66bt0wiwRmARHklz+PuE/uM94sDRVyfnT9R X-Received: by 2002:a05:6214:258a:b0:67a:6216:4a01 with SMTP id fq10-20020a056214258a00b0067a62164a01mr859029qvb.0.1703222748643; Thu, 21 Dec 2023 21:25:48 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1703222748; cv=none; d=google.com; s=arc-20160816; b=1H1k4sHQtQe1HoVTfbTurpuKxqxuk3hBJmrr8I5MzogBPNlOmkg/cRVijkuMY7SIyq IYnmoRdEjYGSz/72xDkXZpj6VfAIWiUEyWGjs/40YF//Z179RL0Otu7izwrf5p6OaFZ6 OQH2n3ETSDNOSgMuN6H8dub8RGkq0llRc1Rq09eR8gsovLR0ccRC4/k2EwIKy+G5ynt+ 89BUKc05DpsxSF17Oq9KXjU6PFqqUyq9LewwthUWzMEvXqiOaHf33O+MoJuecwSBTbRi YG57v1wHSgU60TQ63U6RirLS3D6ai+giGAUyMmmwlNsjnmW3y8W99zTLC3rvT1khkF6A 79bg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:references:in-reply-to:message-id :date:subject:cc:to:from:dkim-signature; bh=dsMR+WACwlCN6vo2Aferq2y6mgFg8ofBbNv8oumItv4=; fh=fZ0/Cw+xoRxI3Qielm39cPIAeEqmtcSUTkwOIQBAkI0=; b=Xn/YYhJy7J+pPyJh0xA1f56emGg2hH9VUv3zZM+ZhVTACBalFsP4iZ0PZQqyavpJ+e 9pvSTplytYbaXj7fF/2b8OVWv9G6XiZgUHq07lw9wGw79lVFxmAsh/bPHm5rZGivhh9g lsqBeEmfAkqc2C9jvEC16hnH4ZdJ/T5JydGBP5X89pvvS6IheGShYe4GeJhGYvQMnBlm Dq/eLs4Nudw2DL7ZYduVmKUq7GmWAbagdVuU9RiDr1PQNN4zfc+S+ZBAIprsITeAERsR jRCIFAwDdZEnhQCspf7e3tzcReFD6End9Mkkv3gfLaSJvbBYnNDRxntx2TFtRo6ohs5u /itg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=0eo9Cvsx; spf=pass (google.com: domain of linux-kernel+bounces-9363-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-9363-ouuuleilei=gmail.com@vger.kernel.org" Received: from ny.mirrors.kernel.org (ny.mirrors.kernel.org. [2604:1380:45d1:ec00::1]) by mx.google.com with ESMTPS id c2-20020a0ce642000000b0067f8284e660si2975186qvn.214.2023.12.21.21.25.48 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 21 Dec 2023 21:25:48 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-9363-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=0eo9Cvsx; spf=pass (google.com: domain of linux-kernel+bounces-9363-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-9363-ouuuleilei=gmail.com@vger.kernel.org" Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ny.mirrors.kernel.org (Postfix) with ESMTPS id 676431C24AE0 for ; Fri, 22 Dec 2023 05:25:48 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 45C13B64C; Fri, 22 Dec 2023 05:25:26 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="0eo9Cvsx" X-Original-To: linux-kernel@vger.kernel.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 721E46112 for ; Fri, 22 Dec 2023 05:25:22 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:References:In-Reply-To:Message-ID:Date:Subject:Cc:To:From:Sender :Reply-To:Content-Type:Content-ID:Content-Description; bh=dsMR+WACwlCN6vo2Aferq2y6mgFg8ofBbNv8oumItv4=; b=0eo9CvsxjzpdF4U8hBbO9yLtRL uH7OLXC6gHLsYCYHri2luyui/yGzD1l0Yls0YhM0QWEyjG8Xb64le1VcBc2AFFavd+aJkAhBp8HY+ kSjMRJEA1S5g2L1TcL6X8Rkz/BM7KnY1e233RDtwoCcmgjNMUurH+a88nkIa4efdl6hmdUZgE5lap fij3uPbGitQYLy5E01roa3wQ6mP/ZE0DZRpjs5rO3DVuPBnIsGYAgb/lMg6PKryF9koOFSt0u/glN y6VeCt+jD9rAUdJKude4AbmFuthCKyhyMJnVg0Rw3GMJFbGlyHB9iYj6rQHgUfYRpxoB15IPNrU08 KFhMwalQ==; Received: from [50.53.46.231] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1rGY2D-004y0F-2j; Fri, 22 Dec 2023 05:25:21 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Hans de Goede , Arnd Bergmann , Greg Kroah-Hartman Subject: [PATCH 2/3] virt: vbox: linux: fix all kernel-doc warnings Date: Thu, 21 Dec 2023 21:25:20 -0800 Message-ID: <20231222052521.14333-2-rdunlap@infradead.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20231222052521.14333-1-rdunlap@infradead.org> References: <20231222052521.14333-1-rdunlap@infradead.org> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1785958496713319538 X-GMAIL-MSGID: 1785958496713319538 Use kernel-doc format for functions that are almost complete in their kernel-doc comments. For other functions, just change the comment to a common C comment. This prevents 7 kernel-doc warnings. Signed-off-by: Randy Dunlap Cc: Hans de Goede Cc: Arnd Bergmann Cc: Greg Kroah-Hartman --- drivers/virt/vboxguest/vboxguest_linux.c | 22 +++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff -- a/drivers/virt/vboxguest/vboxguest_linux.c b/drivers/virt/vboxguest/vboxguest_linux.c --- a/drivers/virt/vboxguest/vboxguest_linux.c +++ b/drivers/virt/vboxguest/vboxguest_linux.c @@ -81,10 +81,11 @@ static int vbg_misc_device_user_open(str } /** - * Close device. - * Return: 0 on success, negated errno on failure. + * vbg_misc_device_close - Close device. * @inode: Pointer to inode info structure. * @filp: Associated file pointer. + * + * Return: %0 on success, negated errno on failure. */ static int vbg_misc_device_close(struct inode *inode, struct file *filp) { @@ -94,11 +95,12 @@ static int vbg_misc_device_close(struct } /** - * Device I/O Control entry point. - * Return: 0 on success, negated errno on failure. + * vbg_misc_device_ioctl - Device I/O Control entry point. * @filp: Associated file pointer. * @req: The request specified to ioctl(). * @arg: The argument specified to ioctl(). + * + * Return: %0 on success, negated errno on failure. */ static long vbg_misc_device_ioctl(struct file *filp, unsigned int req, unsigned long arg) @@ -173,7 +175,7 @@ out: return ret; } -/** The file_operations structures. */ +/* The file_operations structures. */ static const struct file_operations vbg_misc_device_fops = { .owner = THIS_MODULE, .open = vbg_misc_device_open, @@ -193,7 +195,7 @@ static const struct file_operations vbg_ #endif }; -/** +/* * Called when the input device is first opened. * * Sets up absolute mouse reporting. @@ -206,7 +208,7 @@ static int vbg_input_open(struct input_d return vbg_core_set_mouse_status(gdev, feat); } -/** +/* * Called if all open handles to the input device are closed. * * Disables absolute reporting. @@ -218,7 +220,7 @@ static void vbg_input_close(struct input vbg_core_set_mouse_status(gdev, 0); } -/** +/* * Creates the kernel input device. * * Return: 0 on success, negated errno on failure. @@ -277,7 +279,7 @@ static struct attribute *vbg_pci_attrs[] }; ATTRIBUTE_GROUPS(vbg_pci); -/** +/* * Does the PCI detection and init of the device. * * Return: 0 on success, negated errno on failure. @@ -453,7 +455,7 @@ void vbg_put_gdev(struct vbg_dev *gdev) } EXPORT_SYMBOL(vbg_put_gdev); -/** +/* * Callback for mouse events. * * This is called at the end of the ISR, after leaving the event spinlock, if