From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pf1-f182.google.com (mail-pf1-f182.google.com [209.85.210.182]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 3DBA52E859 for ; Fri, 8 Mar 2024 05:44:02 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.210.182 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1709876643; cv=none; b=KyaYoXFn6ih5T7Xn0AtxbqI0R0UejW4OEIBkl1PRENi+vDbdx6FTFlhQx+va6aZBbgXUjaay7WLMTLmwX6s4vWBSQExuyBg4t9H3x9zUg66A9RPU14kpOaAiqdBwTBQZrawKYbeOqUvZvw4+RfOhun0CzpNTX3C6xkMVRJtHEWM= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1709876643; c=relaxed/simple; bh=l8mRvqhe3rCJcL5EfXN0mb564Hh0Pb6/VhQn5bYxOzY=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=HVHa5oYMwV+PFfRuqmCcVzUir8RnabP5Lj+T1pl11HEwRfDMkjgVTXYDasJiY9qxbFYjogM6CziEhJjJkLn41lsPRSRUl3Fe0jpT2Uyar2s1HjZgrMFogs3gmVVHem9S7lp7eXHpsFxnaF3pRRVSBo/Ywkdc+cvye2O/fRMhE8g= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linaro.org; spf=pass smtp.mailfrom=linaro.org; dkim=pass (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b=zd+u7b/x; arc=none smtp.client-ip=209.85.210.182 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=linaro.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="zd+u7b/x" Received: by mail-pf1-f182.google.com with SMTP id d2e1a72fcca58-6e64cdf08e3so373852b3a.3 for ; Thu, 07 Mar 2024 21:44:02 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1709876642; x=1710481442; darn=vger.kernel.org; h=in-reply-to:content-transfer-encoding:content-disposition :mime-version:references:message-id:subject:cc:to:from:date:from:to :cc:subject:date:message-id:reply-to; bh=pP3WC4SyW/Vzti9hv7dYhKLJSQ5hGnrzQR/QY37QH6U=; b=zd+u7b/xgUU80tS+jXojilCTJsZNAWM0d/l1V2BF7G3oMIX/oHjrnKgWd2Y5dPETnX CmipROa7r+nU+Fdg1Uap2Jk6f44e/qPEA0R63CrgAKhltZMrOk0TR+adtl/8hl9t98K5 35BOmSiUcEN61VdQAxeczgEZjLHCOhxH6Ccu6EPqDfm3VGfhnFetaA3kZxaquwgh3RG5 oRVJLoynmllmSaMbUmqjusGc2fsoja+oa4/hwz7soyBV61zju8MaIGwePXOnI2G3AS/W G2qF3pYugdabM8Os35OITh5uSuGb9mC5zvO4BqdxiVUbi4VWE3RdA4hbQV1wa/yr6sHW Yicg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1709876642; x=1710481442; h=in-reply-to:content-transfer-encoding:content-disposition :mime-version:references:message-id:subject:cc:to:from:date :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=pP3WC4SyW/Vzti9hv7dYhKLJSQ5hGnrzQR/QY37QH6U=; b=TLXb/YAHxbjdNEZBIBmdOuRxjwJLHUYU4Dsy2UHl6QDRx1WQ1/qFT4d4TsfKxW3su+ ADPT8bIccCNWnm1CLxLVS9LEGyZAyWLPtfFFPenLeoumkqYj2of1okGlcQrfkNd8pe1A 9A6pHcFwb95nyvSuxrUuohCXzNDwlFgePoON+SazLc4r6pcQkDjz7rV+e4044Rf5KdII 1SS/ftuYtjdOh4AnexxMM+oVjY6hpwowJ5+UYjfd+gR0WHbs8iUiJVaTUG1/WLRDnO9x 2Obul8r1jtagmyPdqsl7CTZswpk/x1ML7ptyUTyhDDs8/dKFetZ+M2Z7bCJKuroN2fOR pStA== X-Forwarded-Encrypted: i=1; AJvYcCWa5F0QCeicP02J/DQ1lmz0S9wgXo9y1JCdTZNYzuF8xoSnNyT2WGKgQ7lw3XMhnd3lnRWsmGtix6nTZTzPowg9wC3f7GvrP3XAMKBEgA== X-Gm-Message-State: AOJu0YxT3ZhGqYtETqZ+q+yTjC5dsxOI1mq8SjW7NBE6PoM31+x33N9Y ruSC0jeZMouZPZuihHPwP1XC9FvNofmsZHMAMPFEeCn5KkrS3zXVopsPFkyLtA== X-Google-Smtp-Source: AGHT+IF4OBcYmj84dqXR/j7tUWistQOyDNgAnoteok0JgpLNMa/4XKXGz0eVlhJR+Ieyw9pe6cuoUw== X-Received: by 2002:a05:6a00:815:b0:6e5:9a92:f99b with SMTP id m21-20020a056a00081500b006e59a92f99bmr19446806pfk.16.1709876641435; Thu, 07 Mar 2024 21:44:01 -0800 (PST) Received: from thinkpad ([117.217.178.39]) by smtp.gmail.com with ESMTPSA id e3-20020aa79803000000b006e5667793d4sm13354830pfl.66.2024.03.07.21.43.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 07 Mar 2024 21:44:01 -0800 (PST) Date: Fri, 8 Mar 2024 11:13:47 +0530 From: Manivannan Sadhasivam To: Niklas Cassel 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: <20240308054347.GE3789@thinkpad> References: <20240304-pci-dbi-rework-v9-0-29d433d99cda@linaro.org> <20240304-pci-dbi-rework-v9-10-29d433d99cda@linaro.org> Precedence: bulk X-Mailing-List: linux-arm-msm@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: On Thu, Mar 07, 2024 at 10:58:12PM +0100, Niklas Cassel wrote: > 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). > Makes sense! Will change it. - Mani -- மணிவண்ணன் சதாசிவம்