From nobody Tue May 14 17:41:12 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=quarantine dis=none) header.from=crudebyte.com ARC-Seal: i=1; a=rsa-sha256; t=1646316852; cv=none; d=zohomail.com; s=zohoarc; b=Sq6/OtCyTYtuqu5Cy6dRsWKZFfa9frQWuVfs3F4TK71LLP0kyQ+eWVKr0bGshUP59aUN4K1F5+25wrmmG4FNnK3gSJ4UetUbYGto8K7GjkQrbNygMKtkSkhs2nlGU1+EL+taYdJupkIoAUAYXRn/sSEF2Bxxm7vBg8FOAvBC910= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1646316852; h=Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:Message-ID:References:Sender:Subject:To; bh=HYWQLwM45yIAcCDavu5L+fT1CR0InuCX/xb5ojwp1DA=; b=DvUMCNDSo6dDeNW5tQQg7becRQzFlaUaUVxX7F/37vIlJGItZxW55H/XHvPz34nGEq6/89lN6U6vQ5x/WCxxH4DJ7SsovtMBP+jjrrFoCm3R0ZeSIALP0IpgmnXI6q6kZj9fzz+z0ZbPjYeb38crEd5iXEsmw0ulaSfTQdUL3Vs= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1646316852020307.98301072696927; Thu, 3 Mar 2022 06:14:12 -0800 (PST) Received: from localhost ([::1]:57418 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nPmDa-0003k1-C6 for importer@patchew.org; Thu, 03 Mar 2022 09:14:10 -0500 Received: from eggs.gnu.org ([209.51.188.92]:54390) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from <2b8f91de7bac3d3bc85d60eb08830a35a394be75@lizzy.crudebyte.com>) id 1nPmCM-0002s2-Ld for qemu-devel@nongnu.org; Thu, 03 Mar 2022 09:12:54 -0500 Received: from lizzy.crudebyte.com ([91.194.90.13]:43571) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from <2b8f91de7bac3d3bc85d60eb08830a35a394be75@lizzy.crudebyte.com>) id 1nPmCK-0005Ak-4S for qemu-devel@nongnu.org; Thu, 03 Mar 2022 09:12:54 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=crudebyte.com; s=lizzy; h=Cc:To:Subject:Date:From:References:In-Reply-To: Message-Id:Content-Type:Content-Transfer-Encoding:MIME-Version:Content-ID: Content-Description; bh=HYWQLwM45yIAcCDavu5L+fT1CR0InuCX/xb5ojwp1DA=; b=fbOdC uO/AwzNpjzmWhpEJ/UH1+Wp6MGcziKRRxq+8B1SZOGZWqdKUXAuEhW2zaJhBdtDmHGEgxaUDb5uw2 cpn4KcbD/yQOz9cSbiWX7ckK03VjZgrhz2P+Bs0M8XCQG0k8syfTcwr4rK0Id4fGBgKd9uU9iMkam Q2e4fz4I8zkCOazTh/YBKs/eezZMDryH/rsbOrsYjQcye1mkuE0gXfvMc0MUF0rCtjo3cQNiCUe0R cEwu49z2acvCZpRcIq4678lIkf4qm/Y5nRJp41xOlvpviyLKmSKYJfSLodra9KTMuCByaYnuBVozP xHs7mi8oRXmOMH5A+NcOYd5g7RwKQ==; Message-Id: <2b8f91de7bac3d3bc85d60eb08830a35a394be75.1646314856.git.qemu_oss@crudebyte.com> In-Reply-To: References: From: Christian Schoenebeck Date: Thu, 3 Mar 2022 13:28:17 +0100 Subject: [PATCH 1/6] 9pfs/9p.h: convert Doxygen -> kerneldoc format To: qemu-devel@nongnu.org Cc: Greg Kurz Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: none client-ip=91.194.90.13; envelope-from=2b8f91de7bac3d3bc85d60eb08830a35a394be75@lizzy.crudebyte.com; helo=lizzy.crudebyte.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, SPF_HELO_NONE=0.001, SPF_NONE=0.001, T_SCC_BODY_TEXT_LINE=-0.01 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+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: pass (identity @crudebyte.com) X-ZM-MESSAGEID: 1646316854164100001 Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" API doc comments in QEMU are supposed to be in kerneldoc format, so convert API doc comments from Doxygen format to kerneldoc format. Based-on: Signed-off-by: Christian Schoenebeck Reviewed-by: Greg Kurz --- hw/9pfs/9p.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/hw/9pfs/9p.h b/hw/9pfs/9p.h index 94b273b3d0..af2635fae9 100644 --- a/hw/9pfs/9p.h +++ b/hw/9pfs/9p.h @@ -100,8 +100,8 @@ typedef enum P9ProtoVersion { V9FS_PROTO_2000L =3D 0x02, } P9ProtoVersion; =20 -/** - * @brief Minimum message size supported by this 9pfs server. +/* + * Minimum message size supported by this 9pfs server. * * A client establishes a session by sending a Tversion request along with= a * 'msize' parameter which suggests the server a maximum message size ever= to be @@ -231,7 +231,7 @@ static inline void v9fs_readdir_init(P9ProtoVersion pro= to_version, V9fsDir *dir) } } =20 -/** +/* * Type for 9p fs drivers' (a.k.a. 9p backends) result of readdir requests, * which is a chained list of directory entries. */ @@ -289,8 +289,8 @@ typedef enum AffixType_t { AffixType_Suffix, /* A.k.a. postfix. */ } AffixType_t; =20 -/** - * @brief Unique affix of variable length. +/* + * Unique affix of variable length. * * An affix is (currently) either a suffix or a prefix, which is either * going to be prepended (prefix) or appended (suffix) with some other @@ -304,7 +304,7 @@ typedef struct VariLenAffix { AffixType_t type; /* Whether this affix is a suffix or a prefix. */ uint64_t value; /* Actual numerical value of this affix. */ /* - * Lenght of the affix, that is how many (of the lowest) bits of @c va= lue + * Lenght of the affix, that is how many (of the lowest) bits of ``val= ue`` * must be used for appending/prepending this affix to its final resul= ting, * unique number. */ --=20 2.30.2 From nobody Tue May 14 17:41:12 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=quarantine dis=none) header.from=crudebyte.com ARC-Seal: i=1; a=rsa-sha256; t=1646316762; cv=none; d=zohomail.com; s=zohoarc; b=LKrtFzXiv6fQIH9nt2gX1kKWwj8inivmSHlK0zXUkcb82QzjhhCG5urrIgATU6/02l9CnLOhvx9w8pZDD7nqGWNAHH426yhVGLIrxDlb362H1oix9irB33b2YfcDqLjJ8hnXh4V36jxfkTE/r/CwkGUCBG+hTXMax/q13eD2DYA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1646316762; h=Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:Message-ID:References:Sender:Subject:To; bh=Af/BjitTk4JBVIjOQi8IT8c4pCz9XxdggxpmyrGmP4c=; b=FntPUC+x9bnpwWp9fSFrjR4Cmc+vcBPlF8l2dCH5JanZ8SwXXNtuMEpmsO33md/DdGZvWmPwEWIWDqmgKsT9mJtDXmbEO8dBsetK3z3A42LFGrKhzXXOo8RQXp3j1iotKNsvwKSkrOS3nh78gy5c/DTKokn4JHGThvGnpdYUEY8= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1646316762303132.64320065917548; Thu, 3 Mar 2022 06:12:42 -0800 (PST) Received: from localhost ([::1]:55260 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nPmC9-0002Hv-PV for importer@patchew.org; Thu, 03 Mar 2022 09:12:41 -0500 Received: from eggs.gnu.org ([209.51.188.92]:54078) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nPmBL-0001Wb-3B for qemu-devel@nongnu.org; Thu, 03 Mar 2022 09:11:51 -0500 Received: from lizzy.crudebyte.com ([91.194.90.13]:38101) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nPmBJ-00050p-HZ for qemu-devel@nongnu.org; Thu, 03 Mar 2022 09:11:50 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=crudebyte.com; s=lizzy; h=Cc:To:Subject:Date:From:References:In-Reply-To: Message-Id:Content-Type:Content-Transfer-Encoding:MIME-Version:Content-ID: Content-Description; bh=Af/BjitTk4JBVIjOQi8IT8c4pCz9XxdggxpmyrGmP4c=; b=RjEpX KxNMuuivjvFLlueoMgYExW5UU2PYoZ0EBAMEIdcqvTJo8lIosVMRaU/q/8vYacmHkc3SBpEyOhIGX T7BXmhUOr4Lm+KH8GYZYCB6MvPEcoPIzP2OLHxoceDR7YEl+fxAqQDrVACXISc/MLCC+3G1buyi4j a7SVBqUKTFuhuICmPLapNGkvK31Lao4IdkXIRaj92+8mzWNzMIUUHbW4gFI1UAzHZov0etKP3erPG m4BsxZosdPpYZbxpMWpshEMFIaLNdR8q72b3ak9eTsIthHNO4UOErrgE1oE82jii33vdBY2LtrMbT RuhY+phndl5cfw9qqeQ8rtdl1NXyg==; Message-Id: In-Reply-To: References: From: Christian Schoenebeck Date: Thu, 3 Mar 2022 13:52:14 +0100 Subject: [PATCH 2/6] 9pfs/codir.c: convert Doxygen -> kerneldoc format To: qemu-devel@nongnu.org Cc: Greg Kurz Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: none client-ip=91.194.90.13; envelope-from=c76be7d38ea448c6417b2ffb5ccd6b711519a878@lizzy.crudebyte.com; helo=lizzy.crudebyte.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, SPF_HELO_NONE=0.001, SPF_NONE=0.001, T_SCC_BODY_TEXT_LINE=-0.01 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+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: pass (identity @crudebyte.com) X-ZM-MESSAGEID: 1646316764417100001 Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" API doc comments in QEMU are supposed to be in kerneldoc format, so convert API doc comments from Doxygen format to kerneldoc format. Signed-off-by: Christian Schoenebeck Reviewed-by: Greg Kurz --- hw/9pfs/codir.c | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/hw/9pfs/codir.c b/hw/9pfs/codir.c index f96d8ac4e6..75148bc985 100644 --- a/hw/9pfs/codir.c +++ b/hw/9pfs/codir.c @@ -184,14 +184,25 @@ out: } =20 /** - * @brief Reads multiple directory entries in one rush. + * v9fs_co_readdir_many() - Reads multiple directory entries in one rush. + * + * @pdu: the causing 9p (T_readdir) client request + * @fidp: already opened directory where readdir shall be performed on + * @entries: output for directory entries (must not be NULL) + * @offset: initial position inside the directory the function shall + * seek to before retrieving the directory entries + * @maxsize: maximum result message body size (in bytes) + * @dostat: whether a stat() should be performed and returned for + * each directory entry + * Return: resulting response message body size (in bytes) on success, + * negative error code otherwise * * Retrieves the requested (max. amount of) directory entries from the fs * driver. This function must only be called by the main IO thread (top ha= lf). * Internally this function call will be dispatched to a background IO thr= ead * (bottom half) where it is eventually executed by the fs driver. * - * @discussion Acquiring multiple directory entries in one rush from the fs + * Acquiring multiple directory entries in one rush from the fs * driver, instead of retrieving each directory entry individually, is very * beneficial from performance point of view. Because for every fs driver * request latency is added, which in practice could lead to overall @@ -199,20 +210,9 @@ out: * directory) if every directory entry was individually requested from fs * driver. * - * @note You must @b ALWAYS call @c v9fs_free_dirents(entries) after calli= ng + * NOTE: You must ALWAYS call v9fs_free_dirents(entries) after calling * v9fs_co_readdir_many(), both on success and on error cases of this - * function, to avoid memory leaks once @p entries are no longer needed. - * - * @param pdu - the causing 9p (T_readdir) client request - * @param fidp - already opened directory where readdir shall be performed= on - * @param entries - output for directory entries (must not be NULL) - * @param offset - initial position inside the directory the function shall - * seek to before retrieving the directory entries - * @param maxsize - maximum result message body size (in bytes) - * @param dostat - whether a stat() should be performed and returned for - * each directory entry - * @returns resulting response message body size (in bytes) on success, - * negative error code otherwise + * function, to avoid memory leaks once @entries are no longer needed. */ int coroutine_fn v9fs_co_readdir_many(V9fsPDU *pdu, V9fsFidState *fidp, struct V9fsDirEnt **entries, --=20 2.30.2 From nobody Tue May 14 17:41:12 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=quarantine dis=none) header.from=crudebyte.com ARC-Seal: i=1; a=rsa-sha256; t=1646317036; cv=none; d=zohomail.com; s=zohoarc; b=BB4+DRNQV0tVb/mJT/8AvGyg0hwE4zw6xMhJy218EToZB3kEh5jDmbBt0qu9Qkq9EiAqgGc+qOCNiiblQakXS4J2leK2gUquJeuCYZFyVL6f//JNFmzeGfy5erz4jHxF/IXbJJjAvbEqM1xkOXZJ32dcDmsJXeBqiklOh6y2/m0= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1646317036; h=Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:Message-ID:References:Sender:Subject:To; bh=V4GggSmDOuO6bAStwDTHTUPgIePHNz5CuLc9nUdaNIY=; b=gwk00B7P8mB2rPnweQnAAwHt6FmxGtuGbfhKrINJl9OJKmVfypqHH25zsBNLfMbrYyPGzHhKQFCNFSBro3wMRIXMG6+x79ngzLQbH5KwL5164QcvxGaYI9Tlo14N2ZrmkprKOIPunDi3G5fLdt9Zu0CksRpVChVEYfuoDkJ4jSI= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1646317036060709.1543389837899; Thu, 3 Mar 2022 06:17:16 -0800 (PST) Received: from localhost ([::1]:35676 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nPmGZ-0008DB-M5 for importer@patchew.org; Thu, 03 Mar 2022 09:17:15 -0500 Received: from eggs.gnu.org ([209.51.188.92]:55384) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from <4ece6ffa4465c271c6a7c42a3040f42780fcce87@lizzy.crudebyte.com>) id 1nPmFQ-0006N0-Af for qemu-devel@nongnu.org; Thu, 03 Mar 2022 09:16:05 -0500 Received: from lizzy.crudebyte.com ([91.194.90.13]:42473) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from <4ece6ffa4465c271c6a7c42a3040f42780fcce87@lizzy.crudebyte.com>) id 1nPmFM-0005Xe-9O for qemu-devel@nongnu.org; Thu, 03 Mar 2022 09:16:03 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=crudebyte.com; s=lizzy; h=Cc:To:Subject:Date:From:References:In-Reply-To: Message-Id:Content-Type:Content-Transfer-Encoding:MIME-Version:Content-ID: Content-Description; bh=V4GggSmDOuO6bAStwDTHTUPgIePHNz5CuLc9nUdaNIY=; b=EE6pe sKC+R2rGjMEoj5NP11xCl+B2Nttw09pJPbF8lb9GjQFpSDdsIrZdFRYUaK5iqsooqPWhLC9ceHoOT 1FQ3AN4XpVmQa/7/YCsUb4Uz9pgAyQhXahDWitfQMSNuTnPKYTrgP0xq3/w9Zze9aom49IEsR+Wo3 QsPXUVgcCo0wAbeYJlTjkergjCOCvim0IRcxodtQWvQSzjqgVsn/pY2wy5hXOq8uUcwjGmZ1Yo9DD xIYvWf+I9PwyDZFdEkOU2QETVx7j2QH62p6dmB8WAkUNAPSZVbYjlXfVvoAUuq5xA+cY5XpYeK04k 31C+Sn4rVZ1J/z9tMZu87H/P/nXNQ==; Message-Id: <4ece6ffa4465c271c6a7c42a3040f42780fcce87.1646314856.git.qemu_oss@crudebyte.com> In-Reply-To: References: From: Christian Schoenebeck Date: Thu, 3 Mar 2022 14:12:12 +0100 Subject: [PATCH 3/6] 9pfs/9p.c: convert Doxygen -> kerneldoc format To: qemu-devel@nongnu.org Cc: Greg Kurz Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: none client-ip=91.194.90.13; envelope-from=4ece6ffa4465c271c6a7c42a3040f42780fcce87@lizzy.crudebyte.com; helo=lizzy.crudebyte.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, SPF_HELO_NONE=0.001, SPF_NONE=0.001, T_SCC_BODY_TEXT_LINE=-0.01 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+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: pass (identity @crudebyte.com) X-ZM-MESSAGEID: 1646317037166100001 Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" API doc comments in QEMU are supposed to be in kerneldoc format, so convert API doc comments from Doxygen format to kerneldoc format. Signed-off-by: Christian Schoenebeck Reviewed-by: Greg Kurz --- hw/9pfs/9p.c | 62 +++++++++++++++++++++++++++++----------------------- 1 file changed, 35 insertions(+), 27 deletions(-) diff --git a/hw/9pfs/9p.c b/hw/9pfs/9p.c index 7405352c37..a6d6b3f835 100644 --- a/hw/9pfs/9p.c +++ b/hw/9pfs/9p.c @@ -628,8 +628,8 @@ static inline uint64_t mirror64bit(uint64_t value) ((uint64_t)mirror8bit((value >> 56) & 0xff)); } =20 -/** - * @brief Parameter k for the Exponential Golomb algorihm to be used. +/* + * Parameter k for the Exponential Golomb algorihm to be used. * * The smaller this value, the smaller the minimum bit count for the Exp. * Golomb generated affixes will be (at lowest index) however for the @@ -642,28 +642,30 @@ static inline uint64_t mirror64bit(uint64_t value) * should be small, for a large amount of devices k might be increased * instead. The default of k=3D0 should be fine for most users though. * - * @b IMPORTANT: In case this ever becomes a runtime parameter; the value = of + * IMPORTANT: In case this ever becomes a runtime parameter; the value of * k should not change as long as guest is still running! Because that wou= ld * cause completely different inode numbers to be generated on guest. */ #define EXP_GOLOMB_K 0 =20 /** - * @brief Exponential Golomb algorithm for arbitrary k (including k=3D0). + * expGolombEncode() - Exponential Golomb algorithm for arbitrary k + * (including k=3D0). * - * The Exponential Golomb algorithm generates @b prefixes (@b not suffixes= !) + * @n: natural number (or index) of the prefix to be generated + * (1, 2, 3, ...) + * @k: parameter k of Exp. Golomb algorithm to be used + * (see comment on EXP_GOLOMB_K macro for details about k) + * Return: prefix for given @n and @k + * + * The Exponential Golomb algorithm generates prefixes (NOT suffixes!) * with growing length and with the mathematical property of being * "prefix-free". The latter means the generated prefixes can be prepended * in front of arbitrary numbers and the resulting concatenated numbers are * guaranteed to be always unique. * * This is a minor adjustment to the original Exp. Golomb algorithm in the - * sense that lowest allowed index (@param n) starts with 1, not with zero. - * - * @param n - natural number (or index) of the prefix to be generated - * (1, 2, 3, ...) - * @param k - parameter k of Exp. Golomb algorithm to be used - * (see comment on EXP_GOLOMB_K macro for details about k) + * sense that lowest allowed index (@n) starts with 1, not with zero. */ static VariLenAffix expGolombEncode(uint64_t n, int k) { @@ -677,7 +679,9 @@ static VariLenAffix expGolombEncode(uint64_t n, int k) } =20 /** - * @brief Converts a suffix into a prefix, or a prefix into a suffix. + * invertAffix() - Converts a suffix into a prefix, or a prefix into a suf= fix. + * @affix: either suffix or prefix to be inverted + * Return: inversion of passed @affix * * Simply mirror all bits of the affix value, for the purpose to preserve * respectively the mathematical "prefix-free" or "suffix-free" property @@ -701,16 +705,16 @@ static VariLenAffix invertAffix(const VariLenAffix *a= ffix) } =20 /** - * @brief Generates suffix numbers with "suffix-free" property. + * affixForIndex() - Generates suffix numbers with "suffix-free" property. + * @index: natural number (or index) of the suffix to be generated + * (1, 2, 3, ...) + * Return: Suffix suitable to assemble unique number. * * This is just a wrapper function on top of the Exp. Golomb algorithm. * * Since the Exp. Golomb algorithm generates prefixes, but we need suffixe= s, * this function converts the Exp. Golomb prefixes into appropriate suffix= es * which are still suitable for generating unique numbers. - * - * @param n - natural number (or index) of the suffix to be generated - * (1, 2, 3, ...) */ static VariLenAffix affixForIndex(uint64_t index) { @@ -810,8 +814,8 @@ static int qid_inode_prefix_hash_bits(V9fsPDU *pdu, dev= _t dev) return val->prefix_bits; } =20 -/** - * @brief Slow / full mapping host inode nr -> guest inode nr. +/* + * Slow / full mapping host inode nr -> guest inode nr. * * This function performs a slower and much more costly remapping of an * original file inode number on host to an appropriate different inode @@ -823,7 +827,7 @@ static int qid_inode_prefix_hash_bits(V9fsPDU *pdu, dev= _t dev) * qid_path_suffixmap() failed. In practice this slow / full mapping is not * expected ever to be used at all though. * - * @see qid_path_suffixmap() for details + * See qid_path_suffixmap() for details * */ static int qid_path_fullmap(V9fsPDU *pdu, const struct stat *stbuf, @@ -864,8 +868,8 @@ static int qid_path_fullmap(V9fsPDU *pdu, const struct = stat *stbuf, return 0; } =20 -/** - * @brief Quick mapping host inode nr -> guest inode nr. +/* + * Quick mapping host inode nr -> guest inode nr. * * This function performs quick remapping of an original file inode number * on host to an appropriate different inode number on guest. This remappi= ng @@ -1281,12 +1285,15 @@ static int coroutine_fn stat_to_v9stat(V9fsPDU *pdu= , V9fsPath *path, =20 =20 /** - * Convert host filesystem's block size into an appropriate block size for - * 9p client (guest OS side). The value returned suggests an "optimum" blo= ck - * size for 9p I/O, i.e. to maximize performance. + * blksize_to_iounit() - Block size exposed to 9p client. + * Return: block size * * @pdu: 9p client request * @blksize: host filesystem's block size + * + * Convert host filesystem's block size into an appropriate block size for + * 9p client (guest OS side). The value returned suggests an "optimum" blo= ck + * size for 9p I/O, i.e. to maximize performance. */ static int32_t blksize_to_iounit(const V9fsPDU *pdu, int32_t blksize) { @@ -2398,10 +2405,11 @@ out_nofid: } =20 /** - * Returns size required in Rreaddir response for the passed dirent @p nam= e. + * v9fs_readdir_response_size() - Returns size required in Rreaddir respon= se + * for the passed dirent @name. * - * @param name - directory entry's name (i.e. file name, directory name) - * @returns required size in bytes + * @name: directory entry's name (i.e. file name, directory name) + * Return: required size in bytes */ size_t v9fs_readdir_response_size(V9fsString *name) { --=20 2.30.2 From nobody Tue May 14 17:41:12 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=quarantine dis=none) header.from=crudebyte.com ARC-Seal: i=1; a=rsa-sha256; t=1646316695; cv=none; d=zohomail.com; s=zohoarc; b=TzaCCjz6l9N5ANhgmuYvwJaiQXPyaAC0n+UXdhYRVqFbRocqwOi12akaN3o7xdLAp2pFiLf1ZT24WI7aqLg5a6knbQhtmdqip/M8dkIfD0aM/lZqx47YKFcIvhB99qQ+AjU8lX94IfdA29f+rLCDaTXJaN67U81kQYenFc7z5/E= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1646316695; h=Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:Message-ID:References:Sender:Subject:To; bh=DVTDwcXvRype59yN2sXQXKcvUnpXIYBnZNqAPCNetxA=; b=Xl9f/ci/LYAVzy0tkei/A5iEtrNIVkr3gNylAJSweOcPaCCOqWLvaeFKjbs/uBfRgI/2KzBY4k3ZJ/ik0pera4iZ1jQisY1CX4oqbJkIrZWQWkKjQQIAJBRqIKwZHNJdkML9yyEBj937ZctTfs/fY0oByvd9lSCcqjN03Stlm30= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1646316695389812.7191620715316; Thu, 3 Mar 2022 06:11:35 -0800 (PST) Received: from localhost ([::1]:53014 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nPmB4-0000lV-2d for importer@patchew.org; Thu, 03 Mar 2022 09:11:34 -0500 Received: from eggs.gnu.org ([209.51.188.92]:53590) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nPmAK-0008Ol-9e for qemu-devel@nongnu.org; Thu, 03 Mar 2022 09:10:48 -0500 Received: from lizzy.crudebyte.com ([91.194.90.13]:36437) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nPmAI-0004XG-Hr for qemu-devel@nongnu.org; Thu, 03 Mar 2022 09:10:47 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=crudebyte.com; s=lizzy; h=Cc:To:Subject:Date:From:References:In-Reply-To: Message-Id:Content-Type:Content-Transfer-Encoding:MIME-Version:Content-ID: Content-Description; bh=DVTDwcXvRype59yN2sXQXKcvUnpXIYBnZNqAPCNetxA=; b=itSP8 exuZQvUuFxrANj9kWhCxD8ckpxMEJ2vAy6pCQSkNfwhvjjQxAu6Cq9RSsOq8WYaCOGVKUnhiYBqcF TAZnZdtN3ZMEvHQOtl75nYUCzUFR6WZqOrxuehlmy7s8OYlsGtYDGxcrkyqLmVBeB6Q+OA6HO9qN9 ZrfwdonxszL4q2rfiXfq3/tAYtvcjWZyPvWiQeMkdH+bM3w5qXblnPKMPT91gvX/KmB6QhD/7thbl /rUpxPTqBKOknWPyhyMhryZQk6MGysDAnE2yMVzqOx1ryIjl6CFe5sAVDzscuDbJlNA8urObxIyHb 11EBs/UVcAdJghFsXftF2fU50c8Yg==; Message-Id: In-Reply-To: References: From: Christian Schoenebeck Date: Thu, 3 Mar 2022 14:20:29 +0100 Subject: [PATCH 4/6] 9pfs/9p-util.h: convert Doxygen -> kerneldoc format To: qemu-devel@nongnu.org Cc: Greg Kurz Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: none client-ip=91.194.90.13; envelope-from=dc1c4a85e233f5884ee5f6ec96b87db286083df7@lizzy.crudebyte.com; helo=lizzy.crudebyte.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, SPF_HELO_NONE=0.001, SPF_NONE=0.001, T_SCC_BODY_TEXT_LINE=-0.01 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+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: pass (identity @crudebyte.com) X-ZM-MESSAGEID: 1646316697904100001 Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" API doc comments in QEMU are supposed to be in kerneldoc format, so convert API doc comments from Doxygen format to kerneldoc format. Signed-off-by: Christian Schoenebeck Reviewed-by: Greg Kurz --- hw/9pfs/9p-util.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/hw/9pfs/9p-util.h b/hw/9pfs/9p-util.h index 22835c5f61..cfa7af43c5 100644 --- a/hw/9pfs/9p-util.h +++ b/hw/9pfs/9p-util.h @@ -97,7 +97,7 @@ ssize_t flistxattrat_nofollow(int dirfd, const char *file= name, ssize_t fremovexattrat_nofollow(int dirfd, const char *filename, const char *name); =20 -/** +/* * Darwin has d_seekoff, which appears to function similarly to d_off. * However, it does not appear to be supported on all file systems, * so ensure it is manually injected earlier and call here when @@ -113,15 +113,15 @@ static inline off_t qemu_dirent_off(struct dirent *de= nt) } =20 /** - * Duplicate directory entry @dent. + * qemu_dirent_dup() - Duplicate directory entry @dent. + * + * @dent: original directory entry to be duplicated + * Return: duplicated directory entry which should be freed with g_free() * * It is highly recommended to use this function instead of open coding * duplication of dirent objects, because the actual struct dirent * size may be bigger or shorter than sizeof(struct dirent) and correct * handling is platform specific (see gitlab issue #841). - * - * @dent - original directory entry to be duplicated - * @returns duplicated directory entry which should be freed with g_free() */ static inline struct dirent *qemu_dirent_dup(struct dirent *dent) { --=20 2.30.2 From nobody Tue May 14 17:41:12 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=quarantine dis=none) header.from=crudebyte.com ARC-Seal: i=1; a=rsa-sha256; t=1646316932; cv=none; d=zohomail.com; s=zohoarc; b=JUM7bb0op0kCwQAjfBhNqIGGrFXd370njuSQwnnnfcMfd51OfJHheHXE6aNDw3VEbed7LNOmXdrwJcm6CWKPEneH/p2dC05WrX80Y5TQKDvVL4JusjBefctafZ8BNds1E2oenUQXB2h/NBBt3f63pmKv54fgzFc64BL/jRwU9kA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1646316932; h=Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:Message-ID:References:Sender:Subject:To; bh=suW9pBmjvp1z756BBcy07wILv6z1XFsPjCtDDGte0lA=; b=FCz/GuT6JcoWYmEbm9Hp2L0RIlg6fK3b7obLlUoHSMG3RRmdRzNnX3PKPkQur8F5nu+njXoVisGUAsVgbeVmAAnThdactR0De/w89F90zbDWnnIWyu7w3Cogs0ifE/tebRhmP7o0cZzjzjD5TtPq7GQHTRqxTjQG6nd7Z30zTnA= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1646316932082442.4142305305818; Thu, 3 Mar 2022 06:15:32 -0800 (PST) Received: from localhost ([::1]:59602 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nPmEt-0005Cj-3C for importer@patchew.org; Thu, 03 Mar 2022 09:15:31 -0500 Received: from eggs.gnu.org ([209.51.188.92]:54612) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nPmDM-0003rv-Ry for qemu-devel@nongnu.org; Thu, 03 Mar 2022 09:13:56 -0500 Received: from lizzy.crudebyte.com ([91.194.90.13]:36157) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nPmDL-0005Jo-I4 for qemu-devel@nongnu.org; Thu, 03 Mar 2022 09:13:56 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=crudebyte.com; s=lizzy; h=Cc:To:Subject:Date:From:References:In-Reply-To: Message-Id:Content-Type:Content-Transfer-Encoding:MIME-Version:Content-ID: Content-Description; bh=suW9pBmjvp1z756BBcy07wILv6z1XFsPjCtDDGte0lA=; b=DnuKs I9lG6rPeEDP3daHcol8Uj3dVbLMIVEuZAMSf5CFqzTg1uWuwaxqqQ5YV5UiaRJMrfLFWFhykNRash +j3tiw9Z98T054If2Hyo8Ilv3/sq+vPMnZjYY038+pQLMeqsvBmCkL/BlWbP8/BvV2+sme1EGhU0F 7j5pfaMU/VBTOG78gnL+VoDATrCSDOKsZiW+GttCi8+wPpyQoMmC/Ui37J4h+7B1odJzD6HrlmivX qW9uqQ9wj8McG7fl8Ao2Ix1aU6g+hGqkePPxCY0ErDZqyf1rbgo8cCumgvOOBTItx6S/G2fwUX/U2 sqLmKcyppe3iDTzGPHFd2x+G7czIA==; Message-Id: In-Reply-To: References: From: Christian Schoenebeck Date: Thu, 3 Mar 2022 14:22:45 +0100 Subject: [PATCH 5/6] 9pfs/coth.h: drop Doxygen format on v9fs_co_run_in_worker() To: qemu-devel@nongnu.org Cc: Greg Kurz Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: none client-ip=91.194.90.13; envelope-from=a8fdf0290d1e40a68f5577f29aeae12298b70733@lizzy.crudebyte.com; helo=lizzy.crudebyte.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, SPF_HELO_NONE=0.001, SPF_NONE=0.001, T_SCC_BODY_TEXT_LINE=-0.01 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+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: pass (identity @crudebyte.com) X-ZM-MESSAGEID: 1646316934163100001 Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" API doc comments in QEMU are supposed to be in kerneldoc format, so drop Doxygen format used on v9fs_co_run_in_worker() macro. Signed-off-by: Christian Schoenebeck Reviewed-by: Greg Kurz --- hw/9pfs/coth.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/hw/9pfs/coth.h b/hw/9pfs/coth.h index f83c7dda7b..1a1edbdc2a 100644 --- a/hw/9pfs/coth.h +++ b/hw/9pfs/coth.h @@ -19,7 +19,7 @@ #include "qemu/coroutine.h" #include "9p.h" =20 -/** +/* * we want to use bottom half because we want to make sure the below * sequence of events. * @@ -29,7 +29,7 @@ * we cannot swap step 1 and 2, because that would imply worker thread * can enter coroutine while step1 is still running * - * @b PERFORMANCE @b CONSIDERATIONS: As a rule of thumb, keep in mind + * PERFORMANCE CONSIDERATIONS: As a rule of thumb, keep in mind * that hopping between threads adds @b latency! So when handling a * 9pfs request, avoid calling v9fs_co_run_in_worker() too often, because * this might otherwise sum up to a significant, huge overall latency for --=20 2.30.2 From nobody Tue May 14 17:41:12 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=quarantine dis=none) header.from=crudebyte.com ARC-Seal: i=1; a=rsa-sha256; t=1646317111; cv=none; d=zohomail.com; s=zohoarc; b=ndb8acLdhInedYjqNDtShIuclJCuTIeaf+WV96dUsIc+H3aZ05ZPoY2alaN9i8PtyUg0NGji16Uf789ylTp7pl/c4H2MLUMFL/zB82xPcx6G0e0+4kaMjohGfUpflh8A10jgdicHCXlG+E9rgbNbFZTXRznvfgAI1D9lix9t+Vo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1646317111; h=Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:Message-ID:References:Sender:Subject:To; bh=jk1Gx8gVcbmpfpkoeQmr1HkLtDMm6meRye3w7LDKYUo=; b=gs+6URdy2xTDoFRBuq+YdQ5LAXr4k1d0ItYtrGZR2Cb9bXs8AqjuvIXImGBbIDp706HMd1FclPd+BSNEB/6Pt9WL/ywi0lODcyAhkajjmaY/BwyHF8BpN0vZ88R8IIL1JvHJLUzfe2hcQYIQvl9GcCYAxoFybmCmrntuPPrbU0w= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1646317111942373.0176761580316; Thu, 3 Mar 2022 06:18:31 -0800 (PST) Received: from localhost ([::1]:39838 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nPmHm-0002ir-B9 for importer@patchew.org; Thu, 03 Mar 2022 09:18:30 -0500 Received: from eggs.gnu.org ([209.51.188.92]:55878) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from <2e2d46a402560f155de322d95789ba107d728885@lizzy.crudebyte.com>) id 1nPmGS-0000QE-0Y for qemu-devel@nongnu.org; Thu, 03 Mar 2022 09:17:08 -0500 Received: from lizzy.crudebyte.com ([91.194.90.13]:52441) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from <2e2d46a402560f155de322d95789ba107d728885@lizzy.crudebyte.com>) id 1nPmGQ-0005tO-Ax for qemu-devel@nongnu.org; Thu, 03 Mar 2022 09:17:07 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=crudebyte.com; s=lizzy; h=Cc:To:Subject:Date:From:References:In-Reply-To: Message-Id:Content-Type:Content-Transfer-Encoding:MIME-Version:Content-ID: Content-Description; bh=jk1Gx8gVcbmpfpkoeQmr1HkLtDMm6meRye3w7LDKYUo=; b=HecRa UIfn6bSDyd6gl0Sf7LAAqhGBM7QQEoebRb9QT2BHO0E2r18DtLj3LxkAJeBtSHz4cgNRZZ45C0fqk zMEAxmy3KHjtCCrowvrWtleAh4VTh2eh/m7b/Rj8vtfvrrMPesP52Ar/XfGzifvdpn4XaRieFt7K0 EZuLRgKv14YsM6yV0crjHPP9AjQXXsn71upe8SQ/f4UfoSqIjC2dRd/1f6ZKp1XkoaEL6WI3FF00C REBNWVMBkm5acO1AsqL1Uh5xjTKc8nKFnqVUzl84OvnRlObdsHaaD/Ydhd51GXjw1b5DANKutX5Uc Rvin0/Q+R2AxGEcRiscJcC8cJBXbg==; Message-Id: <2e2d46a402560f155de322d95789ba107d728885.1646314856.git.qemu_oss@crudebyte.com> In-Reply-To: References: From: Christian Schoenebeck Date: Thu, 3 Mar 2022 14:37:29 +0100 Subject: [PATCH 6/6] fsdev/p9array.h: convert Doxygen -> kerneldoc format To: qemu-devel@nongnu.org Cc: Greg Kurz Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: none client-ip=91.194.90.13; envelope-from=2e2d46a402560f155de322d95789ba107d728885@lizzy.crudebyte.com; helo=lizzy.crudebyte.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, SPF_HELO_NONE=0.001, SPF_NONE=0.001, T_SCC_BODY_TEXT_LINE=-0.01 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+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: pass (identity @crudebyte.com) X-ZM-MESSAGEID: 1646317113838100001 Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" API doc comments in QEMU are supposed to be in kerneldoc format, so convert API doc comments from Doxygen format to kerneldoc format. Signed-off-by: Christian Schoenebeck Reviewed-by: Greg Kurz --- fsdev/p9array.h | 38 +++++++++++++++++++++----------------- 1 file changed, 21 insertions(+), 17 deletions(-) diff --git a/fsdev/p9array.h b/fsdev/p9array.h index 6aa25327ca..90e83a7c7b 100644 --- a/fsdev/p9array.h +++ b/fsdev/p9array.h @@ -81,11 +81,11 @@ */ =20 /** - * Declares an array type for the passed @a scalar_type. + * P9ARRAY_DECLARE_TYPE() - Declares an array type for the passed @scalar_= type. * - * This is typically used from a shared header file. + * @scalar_type: type of the individual array elements * - * @param scalar_type - type of the individual array elements + * This is typically used from a shared header file. */ #define P9ARRAY_DECLARE_TYPE(scalar_type) \ typedef struct P9Array##scalar_type { \ @@ -97,14 +97,14 @@ void p9array_auto_free_##scalar_type(scalar_type **auto_var); \ =20 /** - * Defines an array type for the passed @a scalar_type and appropriate - * @a scalar_cleanup_func. + * P9ARRAY_DEFINE_TYPE() - Defines an array type for the passed @scalar_ty= pe + * and appropriate @scalar_cleanup_func. * - * This is typically used from a C unit file. + * @scalar_type: type of the individual array elements + * @scalar_cleanup_func: appropriate function to free memory dynamically + * allocated by individual array elements before * - * @param scalar_type - type of the individual array elements - * @param scalar_cleanup_func - appropriate function to free memory dynami= cally - * allocated by individual array elements bef= ore + * This is typically used from a C unit file. */ #define P9ARRAY_DEFINE_TYPE(scalar_type, scalar_cleanup_func) \ void p9array_new_##scalar_type(scalar_type **auto_var, size_t len) \ @@ -132,23 +132,27 @@ } \ =20 /** + * P9ARRAY_REF() - Declare a reference variable for an array. + * + * @scalar_type: type of the individual array elements + * * Used to declare a reference variable (unique pointer) for an array. Aft= er * leaving the scope of the reference variable, the associated array is * automatically freed. - * - * @param scalar_type - type of the individual array elements */ #define P9ARRAY_REF(scalar_type) \ __attribute((__cleanup__(p9array_auto_free_##scalar_type))) scalar_typ= e* =20 /** - * Allocates a new array of passed @a scalar_type with @a len number of ar= ray - * elements and assigns the created array to the reference variable - * @a auto_var. + * P9ARRAY_NEW() - Allocate a new array. * - * @param scalar_type - type of the individual array elements - * @param auto_var - destination reference variable - * @param len - amount of array elements to be allocated immediately + * @scalar_type: type of the individual array elements + * @auto_var: destination reference variable + * @len: amount of array elements to be allocated immediately + * + * Allocates a new array of passed @scalar_type with @len number of array + * elements and assigns the created array to the reference variable + * @auto_var. */ #define P9ARRAY_NEW(scalar_type, auto_var, len) \ QEMU_BUILD_BUG_MSG( \ --=20 2.30.2