From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.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.lore.kernel.org (Postfix) with ESMTPS id 78CC1C54798 for ; Thu, 7 Mar 2024 21:58:40 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:In-Reply-To:MIME-Version:References: Message-ID:Subject:Cc:To:From:Date:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=Ruj5cV2qru77edgnhmZDWxy/7GKN07erTglJU+Ne1dk=; b=w1IRa4doqRUFvT Hgt98ils0XCYwUOrH9oW1bVNkIkh7bcYgBz18ooz1HDD6SHEqu0v5arZlKDC0o2iF0wavXAmQg14k mT3FA6KK+nRioHHjvcOFbi7qgqc9Fws1spSge1AuEEbn8dtMSQOHWz1JR11xaC0BqW2rBN+BMiAw0 zOZe8RFMLnUxoa+uNt36LvsahwwbIRl/v+Py7DGfiU0skKDDN+PA/p8b2M6j+AOUl4AYDjOvJ/+R3 bdisbxP2hO36Bc9hV5+F/fYA4RAV6CS/jFKGl83C/sXdD5TV9WvSDM7duFNAnOBplkMm06MFn8Rum FgpAoQXcMis88H3br5ag==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.97.1 #2 (Red Hat Linux)) id 1riLkx-00000006YHo-2VG6; Thu, 07 Mar 2024 21:58:27 +0000 Received: from dfw.source.kernel.org ([139.178.84.217]) by bombadil.infradead.org with esmtps (Exim 4.97.1 #2 (Red Hat Linux)) id 1riLkt-00000006YGh-3lPj for linux-arm-kernel@lists.infradead.org; Thu, 07 Mar 2024 21:58:25 +0000 Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by dfw.source.kernel.org (Postfix) with ESMTP id 16F0961C0D; Thu, 7 Mar 2024 21:58:23 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 0467CC433C7; Thu, 7 Mar 2024 21:58:14 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1709848702; bh=IpMGeN0v86/rzAMDiUJQ+cVemf+jJKKFwIKCFoUkZTE=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=mxaaxpXHbcwdgPBCqzL3ip4FfS+wwgyZXqW8N8LcK6fP7E3VpoZqDHneR1dd1Xrej WlhBbqSPrM8jK9BJ2CNbm0PQxpC2owo7XLjSqOdrLbuwv5hYXvRYOCPbR1lseTm+lm VqRwXX89Ybnc+o3+MwNbgMhEL3RoQsE5RCRDUDwhBk88OxG95EAluIIMxeXPJNzTfJ xn5x8uaGoDrlqvoXzTQH3DobEay96Lt8ukZK4sO6AxfMPbTZXLi096HQUATFULKEAk NN3FHdZNMxE7mUyR2y+Hg6twSl77vAinM6S2WxrzEAkUA9Ziwka71eJzu4vJy7VSud o4JGQD6O5Yeew== Date: Thu, 7 Mar 2024 22:58:12 +0100 From: Niklas Cassel To: Manivannan Sadhasivam Cc: Jingoo Han , Gustavo Pimentel , Lorenzo Pieralisi , Krzysztof =?utf-8?Q?Wilczy=C5=84ski?= , Rob Herring , Bjorn Helgaas , Marek Vasut , Yoshihiro Shimoda , Thierry Reding , Jonathan Hunter , Kishon Vijay Abraham I , Vidya Sagar , Vignesh Raghavendra , Richard Zhu , Lucas Stach , Shawn Guo , Sascha Hauer , Pengutronix Kernel Team , Fabio Estevam , NXP Linux Team , Minghuan Lian , Mingkai Hu , Roy Zang , Kunihiko Hayashi , Masami Hiramatsu , Kishon Vijay Abraham I , Jesper Nilsson , Srikanth Thokala , linux-pci@vger.kernel.org, linux-kernel@vger.kernel.org, linux-renesas-soc@vger.kernel.org, linux-arm-msm@vger.kernel.org, linux-tegra@vger.kernel.org, linux-omap@vger.kernel.org, linux-arm-kernel@lists.infradead.org, linuxppc-dev@lists.ozlabs.org, linux-arm-kernel@axis.com, Frank Li Subject: Re: [PATCH v9 10/10] PCI: dwc: ep: Add Kernel-doc comments for APIs Message-ID: References: <20240304-pci-dbi-rework-v9-0-29d433d99cda@linaro.org> <20240304-pci-dbi-rework-v9-10-29d433d99cda@linaro.org> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20240304-pci-dbi-rework-v9-10-29d433d99cda@linaro.org> X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20240307_135824_109714_C9B67438 X-CRM114-Status: GOOD ( 13.42 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org On Mon, Mar 04, 2024 at 02:52:22PM +0530, Manivannan Sadhasivam wrote: > All of the APIs are missing the Kernel-doc comments. Hence, add them. > > Reviewed-by: Frank Li > Signed-off-by: Manivannan Sadhasivam > --- For the functions that you added in this series, e.g. dw_pcie_ep_cleanup(), dw_pcie_ep_init_non_sticky_registers(), and dw_pcie_ep_linkdown(), I think that it would have been better if you actually added the kdoc in the same commit that added the respective function. For the existing functions that did not have a kdoc, I think it would have been better if you fixed this as patch 1/10 in this series. (Or 2/10, in case you keep the Fixes tag for the "PCI: dwc: ep: Fix DBI access failure for drivers requiring refclk from host" patch.) Yes, I know that you rename some of these functions that lacked kdoc later in the series, but the whole kdoc description would be the same, the kdoc parameters would be the same, and the kdoc return value would be the same. If you later rename a function, you would only need to change the kdoc function name (in addition to the function declaration itself). Kind regards, Niklas _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel