From patchwork Tue Aug 27 09:55:45 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Chen-Yu Tsai X-Patchwork-Id: 13779223 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 06D3DC5472C for ; Tue, 27 Aug 2024 10:02:04 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender:List-Subscribe:List-Help :List-Post:List-Archive:List-Unsubscribe:List-Id:Content-Transfer-Encoding: MIME-Version:References:In-Reply-To:Message-ID:Date:Subject:Cc:To:From: Reply-To:Content-Type:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=ESZ230OnhQbgGMwqd+oa/xXMpMZe5y6HmOQapIAtswk=; b=bOwhq8KXsAR93xGK2HluSpnQjL Q1G1Sd5bkuqWngbSVfWKElJOb5mx3ATu99/nR5W+gwvMAGwKr9dXaMlfofUPndgte2mk9iyhBjfzA sX0mvnZpzbwb4hs4d4JYIm0fIo7nomOUoTOVvv+sPdtLuDhtTQerwD4wZtNNAzvvJ+cXI9Cz6Kn/a 8vMi4T7cU/FfNV/t3vtF06J3xr16cpHftOYzZcoAAarpYr5mWAv42IeDKfSJ1apx9QVync3MuEq9g +uJYGTiQt2SPHCSxNXba2K0PwRnYaZASRc9UlBfXX86yeU1vQx/SvwDS1IG3F74lbztkFffjDs3VU wuq3MPeQ==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.97.1 #2 (Red Hat Linux)) id 1sit1L-0000000AiL3-3K2F; Tue, 27 Aug 2024 10:01:52 +0000 Received: from mail-pl1-x630.google.com ([2607:f8b0:4864:20::630]) by bombadil.infradead.org with esmtps (Exim 4.97.1 #2 (Red Hat Linux)) id 1sisvo-0000000AgZr-1WQx for linux-arm-kernel@lists.infradead.org; Tue, 27 Aug 2024 09:56:09 +0000 Received: by mail-pl1-x630.google.com with SMTP id d9443c01a7336-20223b5c1c0so47220505ad.2 for ; Tue, 27 Aug 2024 02:56:07 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1724752567; x=1725357367; darn=lists.infradead.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=ESZ230OnhQbgGMwqd+oa/xXMpMZe5y6HmOQapIAtswk=; b=Vx6NSthn0fAcfOc3KsO4NTuu2wh7DKDAD6gFr8drZ6AQFU2kpO6qo5kExJikgTnyq+ 1L6XIU6+yV/Mz4IWeyf1Hqm2ho2L/PApF2hgP4MESn4iwCy6CNoi5yoc9Aoma8Jmf+Gy AN4MB+WuyI3GW2xzKY1WXWZJRfyAYgnSEeP/I= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724752567; x=1725357367; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=ESZ230OnhQbgGMwqd+oa/xXMpMZe5y6HmOQapIAtswk=; b=S8H+EIM2MBK4j8q5s7PIR1/EsqlB6TUT1hA5auk70DUO9dtWe1112UpuU/Bw4njaDr WbTz8AqiGbtIRa/Z9fcS3PNnx2sYqnfnLzaVo6zkgPMl4/q4S37KbwOI/AtvI5q60H2s lrNAVjpzDN09ZTcVTo9HKgilsY9S1DeWjVfqX9D5Uh5OuiKTyZA/nm+1A+phef5nNJDE wvi30DrO7xeJUNXl0wC4an5hrtZdXhH+LfPvNBImM7IpZmCmyC7+oCZi/InYl7bdv7s+ /chYcm4NeOQgozpW61sy4/0k8IGYvH62uWmQej6HUXIe5ohYfjvWPi8QkoCgkVxvCHYh cXcg== X-Forwarded-Encrypted: i=1; AJvYcCUT7iVUix49Phh0KpPiBzquM47n+Jm9S3js1TbmX6GiMnnEhxmeONZ9BA21jktPj4vYqIdLG1zZbJtEVwSH2nVR@lists.infradead.org X-Gm-Message-State: AOJu0YwAyFMZauDs6VapRjZdfy4E82lNE7S5d0+OdBBqHbY/4Xa5Z8wG Mi0fCkx+SBO5QPEpMBxRfu3mGJ0jb2GlIVrEN9Jt06b0b2BneJdItUePbINzE7UZhqBJhYQDwnc = X-Google-Smtp-Source: AGHT+IFFCHZgHL9RBU8dd5+9PfndpKeAF0h1nYtKjBFa8A/QGyHizQ8yJecYPHXnUGL5ASbJDHv72w== X-Received: by 2002:a17:902:ec8a:b0:202:3711:6fe9 with SMTP id d9443c01a7336-204df4d6d6dmr19210065ad.51.1724752566916; Tue, 27 Aug 2024 02:56:06 -0700 (PDT) Received: from wenstp920.tpe.corp.google.com ([2401:fa00:1:10:3102:657e:87f4:c646]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-2038560c2basm80006775ad.222.2024.08.27.02.56.05 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 27 Aug 2024 02:56:06 -0700 (PDT) From: Chen-Yu Tsai To: Mark Brown , Liam Girdwood Cc: Chen-Yu Tsai , linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, Andy Shevchenko Subject: [PATCH 5/8] regulator: of: Fix incorrectly formatted kerneldoc "Return" sections Date: Tue, 27 Aug 2024 17:55:45 +0800 Message-ID: <20240827095550.675018-6-wenst@chromium.org> X-Mailer: git-send-email 2.46.0.295.g3b9ea8a38a-goog In-Reply-To: <20240827095550.675018-1-wenst@chromium.org> References: <20240827095550.675018-1-wenst@chromium.org> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20240827_025608_425634_A4B99FD2 X-CRM114-Status: GOOD ( 17.84 ) 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: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org kernel-doc complains about missing "Return" section for many documented functions in the regulator OF-specific code. These all have descriptions about the return values, just not in the format kernel-doc wants. Convert these to use the proper "Return:" section header. The existing descriptions have been reworded and moved around to fit the grammar and formatting. Signed-off-by: Chen-Yu Tsai --- drivers/regulator/of_regulator.c | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/drivers/regulator/of_regulator.c b/drivers/regulator/of_regulator.c index d557f7b1ec7c..9dab8ee74fde 100644 --- a/drivers/regulator/of_regulator.c +++ b/drivers/regulator/of_regulator.c @@ -338,8 +338,10 @@ static int of_get_regulation_constraints(struct device *dev, * @desc: regulator description * * Populates regulator_init_data structure by extracting data from device - * tree node, returns a pointer to the populated structure or NULL if memory - * alloc fails. + * tree node. + * + * Return: pointer to populated &struct regulator_init_data or NULL if + * memory alloc fails. */ struct regulator_init_data *of_get_regulator_init_data(struct device *dev, struct device_node *node, @@ -391,7 +393,7 @@ static void devm_of_regulator_put_matches(struct device *dev, void *res) * in place and an additional of_node reference is taken for each matched * regulator. * - * Returns the number of matches found or a negative error code on failure. + * Return: the number of matches found or a negative error code on failure. */ int of_regulator_match(struct device *dev, struct device_node *node, struct of_regulator_match *matches, @@ -619,7 +621,7 @@ static bool of_coupling_find_node(struct device_node *src, * - all coupled regulators have the same number of regulator_dev phandles * - all regulators are linked to each other * - * Returns true if all conditions are met. + * Return: true if all conditions are met; false otherwise. */ bool of_check_coupling_data(struct regulator_dev *rdev) { @@ -690,8 +692,8 @@ bool of_check_coupling_data(struct regulator_dev *rdev) * "regulator-coupled-with" property * @index: Index in phandles array * - * Returns the regulator_dev pointer parsed from DTS. If it has not been yet - * registered, returns NULL + * Return: pointer to &struct regulator_dev parsed from DTS, or %NULL if + * it has not yet been registered. */ struct regulator_dev *of_parse_coupled_regulator(struct regulator_dev *rdev, int index)