[{"id":3675292,"web_url":"http://patchwork.ozlabs.org/comment/3675292/","msgid":"","list_archive_url":null,"date":"2026-04-09T12:35:28","subject":"Re: [Intel-wired-lan] [PATCH net-next v2] iavf: fix kernel-doc\n comment style in iavf_ethtool.c","submitter":{"id":71262,"url":"http://patchwork.ozlabs.org/api/people/71262/","name":"Breno Leitao","email":"leitao@debian.org"},"content":"On Thu, Apr 09, 2026 at 11:30:20AM +0200, Aleksandr Loktionov wrote:\n> iavf_ethtool.c contains 31 kernel-doc comment blocks using the legacy\n> `**/` terminator instead of the correct single `*/`. Two function\n> headers also use a colon separator (`iavf_get_channels:`,\n> `iavf_set_channels:`) instead of the ` - ` dash required by kernel-doc.\n> \n> Additionally several comments embed their return-value descriptions in\n> the body paragraph, producing `scripts/kernel-doc -Wreturn` warnings.\n> Void functions that incorrectly say \"Returns ...\" are also rephrased.\n> \n> Fix all issues across the full file:\n> - Replace every `**/` terminator with `*/`.\n> - Change `function_name:` doc headers to `function_name -`.\n> - Move inline \"Returns ...\" sentences into dedicated `Return:` sections\n> for non-void functions (iavf_get_msglevel, iavf_get_rxnfc,\n> iavf_set_channels, iavf_get_rxfh_key_size, iavf_get_rxfh_indir_size,\n> iavf_get_rxfh, iavf_set_rxfh).\n> - Rephrase body descriptions in void functions that incorrectly said\n> \"Returns ...\" (iavf_get_drvinfo, iavf_get_ringparam, iavf_get_coalesce).\n> - Remove boilerplate body text for iavf_get_rxfh_key_size and\n> iavf_get_rxfh_indir_size; the `Return:` line now conveys the same\n> information without the vague \"Returns the table size.\" sentence.\n> \n> Suggested-by: Anthony L. Nguyen \n> Suggested-by: Leszek Pepiak \n> Signed-off-by: Aleksandr Loktionov \n\nReviewed-by: Breno Leitao ","headers":{"Return-Path":"","X-Original-To":["incoming@patchwork.ozlabs.org","intel-wired-lan@lists.osuosl.org"],"Delivered-To":["patchwork-incoming@legolas.ozlabs.org","intel-wired-lan@lists.osuosl.org"],"Authentication-Results":["legolas.ozlabs.org;\n\tdkim=pass (2048-bit key;\n unprotected) header.d=osuosl.org header.i=@osuosl.org header.a=rsa-sha256\n header.s=default header.b=T34IdG67;\n\tdkim-atps=neutral","legolas.ozlabs.org;\n spf=pass (sender SPF authorized) smtp.mailfrom=osuosl.org\n (client-ip=2605:bc80:3010::137; helo=smtp4.osuosl.org;\n envelope-from=intel-wired-lan-bounces@osuosl.org;\n receiver=patchwork.ozlabs.org)"],"Received":["from smtp4.osuosl.org (smtp4.osuosl.org [IPv6:2605:bc80:3010::137])\n\t(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)\n\t key-exchange x25519 server-signature ECDSA (secp384r1) server-digest SHA384)\n\t(No client certificate requested)\n\tby legolas.ozlabs.org (Postfix) with ESMTPS id 4frztX1NlWz1xy1\n\tfor ; Thu, 09 Apr 2026 22:35:47 +1000 (AEST)","from localhost (localhost [127.0.0.1])\n\tby smtp4.osuosl.org (Postfix) with ESMTP id 642514087A;\n\tThu, 9 Apr 2026 12:35:46 +0000 (UTC)","from smtp4.osuosl.org ([127.0.0.1])\n by localhost (smtp4.osuosl.org [127.0.0.1]) (amavis, port 10024) with ESMTP\n id HO95Je1CDF4r; Thu, 9 Apr 2026 12:35:45 +0000 (UTC)","from lists1.osuosl.org (lists1.osuosl.org [140.211.166.142])\n\tby smtp4.osuosl.org (Postfix) with ESMTP id 91990407F3;\n\tThu, 9 Apr 2026 12:35:45 +0000 (UTC)","from smtp1.osuosl.org (smtp1.osuosl.org [IPv6:2605:bc80:3010::138])\n by lists1.osuosl.org (Postfix) with ESMTP id 73C5F1F6\n for ; Thu, 9 Apr 2026 12:35:44 +0000 (UTC)","from localhost (localhost [127.0.0.1])\n by smtp1.osuosl.org (Postfix) with ESMTP id 59B5581445\n for ; Thu, 9 Apr 2026 12:35:44 +0000 (UTC)","from smtp1.osuosl.org ([127.0.0.1])\n by localhost (smtp1.osuosl.org [127.0.0.1]) (amavis, port 10024) with ESMTP\n id rBKTB_595-8S for ;\n Thu, 9 Apr 2026 12:35:43 +0000 (UTC)","from stravinsky.debian.org (stravinsky.debian.org\n [IPv6:2001:41b8:202:deb::311:108])\n by smtp1.osuosl.org (Postfix) with ESMTPS id 558788143D\n for ; Thu, 9 Apr 2026 12:35:43 +0000 (UTC)","from authenticated user by stravinsky.debian.org with esmtpsa\n (TLS1.3:ECDHE_X25519__RSA_PSS_RSAE_SHA256__AES_256_GCM:256)\n (Exim 4.96) (envelope-from ) id 1wAobc-009CdJ-16;\n Thu, 09 Apr 2026 12:35:32 +0000"],"X-Virus-Scanned":["amavis at osuosl.org","amavis at osuosl.org"],"X-Comment":"SPF check N/A for local connections - client-ip=140.211.166.142;\n helo=lists1.osuosl.org; envelope-from=intel-wired-lan-bounces@osuosl.org;\n receiver= ","DKIM-Filter":["OpenDKIM Filter v2.11.0 smtp4.osuosl.org 91990407F3","OpenDKIM Filter v2.11.0 smtp1.osuosl.org 558788143D"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=osuosl.org;\n\ts=default; t=1775738145;\n\tbh=w706NqgBqyMKvr0nVOHn4NlIhTaCVyxRXyIz0wu2eTw=;\n\th=Date:From:To:Cc:References:In-Reply-To:Subject:List-Id:\n\t List-Unsubscribe:List-Archive:List-Post:List-Help:List-Subscribe:\n\t From;\n\tb=T34IdG677omdV5Mm+zotG6xSw+781CGS2xI7dj6fZ30bHBqDfZJC8TUbbEcE0edrw\n\t 0br//nxV8ahXiA/glAyqbIri7aMIIQAqo3wJ3V5uol7j3UlzRh20T3qw+KPRVCttLt\n\t 5pEnkQsXLZOWU47gJFHPG3ZuznvMJrSAclX88Od2JWjMCp8xtsn0XvPml8QyUv1FdL\n\t koW3e1ObE3YsZXOo7KPcgPC41IAo1ppjsuDWSecpY5YBtgJvxLc9f2eqIb1QGZaIZh\n\t A4iofW5SBQT/+4NiFqxrj4kQCI8Epxap53gXTr3v3xb8oogMVUvMRlMKTvM4oVZmnd\n\t vm0oO2rBZKaCA==","Received-SPF":"None (mailfrom) identity=mailfrom;\n client-ip=2001:41b8:202:deb::311:108; helo=stravinsky.debian.org;\n envelope-from=leitao@debian.org; receiver=","DMARC-Filter":"OpenDMARC Filter v1.4.2 smtp1.osuosl.org 558788143D","Date":"Thu, 9 Apr 2026 05:35:28 -0700","From":"Breno Leitao ","To":"Aleksandr Loktionov ","Cc":"intel-wired-lan@lists.osuosl.org, anthony.l.nguyen@intel.com,\n netdev@vger.kernel.org, Leszek Pepiak ","Message-ID":"","References":"<20260409093020.3808687-1-aleksandr.loktionov@intel.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=us-ascii","Content-Disposition":"inline","In-Reply-To":"<20260409093020.3808687-1-aleksandr.loktionov@intel.com>","X-Debian-User":"leitao","X-Mailman-Original-DKIM-Signature":"v=1; a=rsa-sha256; q=dns/txt;\n c=relaxed/relaxed; d=debian.org;\n s=smtpauto.stravinsky; h=X-Debian-User:In-Reply-To:Content-Type:MIME-Version:\n References:Message-ID:Subject:Cc:To:From:Date:Reply-To:\n Content-Transfer-Encoding:Content-ID:Content-Description;\n bh=w706NqgBqyMKvr0nVOHn4NlIhTaCVyxRXyIz0wu2eTw=; b=OC2TM+lfxYsLQIhsCdB3HrmzIP\n 054IXBC5UmIQIuU01hqYd0KX4/xz+4PAH8Kg9X5PRVH8Pddy86B4veXRGWqPjJz838D7tkhHHYJ7U\n dP0ENSI6N3dwoH+L8DqU9Ml2ob5B1rcwo9Z0P8EMb9TQQTq8bAtgaLQM3geR57eZPjcT/FR//ohZr\n XPfJql6cSUVy16+W0D0hSf/ZQnCstnMP7SCJwBYjbd193ja0sUlJOBy/7LD0m6Ez+kYqGgu55CrzZ\n /E1FXD28pda3h1/NhV1KCQkivjTdHkg2Z44tFBlXDTnraek4mzyB/y2OYno8/5mbEzMbeLwXQyMpY\n IMSr4ziQ==;","X-Mailman-Original-Authentication-Results":["smtp1.osuosl.org;\n dmarc=none (p=none dis=none)\n header.from=debian.org","smtp1.osuosl.org;\n dkim=pass (2048-bit key,\n unprotected) header.d=debian.org header.i=@debian.org header.a=rsa-sha256\n header.s=smtpauto.stravinsky header.b=OC2TM+lf"],"Subject":"Re: [Intel-wired-lan] [PATCH net-next v2] iavf: fix kernel-doc\n comment style in iavf_ethtool.c","X-BeenThere":"intel-wired-lan@osuosl.org","X-Mailman-Version":"2.1.30","Precedence":"list","List-Id":"Intel Wired Ethernet Linux Kernel Driver Development\n ","List-Unsubscribe":",\n ","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n ","Errors-To":"intel-wired-lan-bounces@osuosl.org","Sender":"\"Intel-wired-lan\" "}}]