From patchwork Thu Aug 29 08:51:26 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: 13782804 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 C36EDC8300F for ; Thu, 29 Aug 2024 09:02:16 +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=sgPHavE7K4ClGYJgJpC5pW6t6qCTjxay4H8VAVIO8qM=; b=y+bBuRxuY/6e0EXLzGLljnP+rj ETlnYuNgZkKh16ycLC0XtORdlYhfVYenzXJZ5zFFjVwNN3SHN/4PGRn/5pdvDU+PB3jN2vyHjPm/6 IkcwI0XFCI+BcbrLTYganF0Upyh6ckCg1A54mtXavu1JuMbPeNR64ElAR+ghjhYNMZu48YGJIEWcr u3JjvViCKmXsD5qfgVFfp+OCyfv/4H94nHuxLkhUkPi52mlx7usJaI4LHRwF39H3Mf/hAIXjBZ0VO B9z6PnvQG67PYn4RM4cZ802FsO1W+aTFVMw1yAqO6QJCZQCSxVxVKXAB2OW+X9NSuyB6lZ0Og7ZEK aUxiC6mg==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.97.1 #2 (Red Hat Linux)) id 1sjb2b-00000001GMC-2OtS; Thu, 29 Aug 2024 09:02:05 +0000 Received: from mail-pl1-x62a.google.com ([2607:f8b0:4864:20::62a]) by bombadil.infradead.org with esmtps (Exim 4.97.1 #2 (Red Hat Linux)) id 1sjasr-00000001Drl-3JxO for linux-arm-kernel@lists.infradead.org; Thu, 29 Aug 2024 08:52:03 +0000 Received: by mail-pl1-x62a.google.com with SMTP id d9443c01a7336-20203988f37so3971315ad.1 for ; Thu, 29 Aug 2024 01:52:01 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1724921521; x=1725526321; 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=sgPHavE7K4ClGYJgJpC5pW6t6qCTjxay4H8VAVIO8qM=; b=gPaUv3+L+TjONulc7BAKwpCpsGlu6GIBwnnp+NOawE9Ms8cjJeb0xjSPMngdoAhR6b TXY9WvYdmCfyMuPAYpm5GMJ/5YVzIZ6QKUwd7aO17baxx9RqePYqSIX4JdGBQt4Dvod/ pQ1F0YK7hNpy5yMWafRiD4TVn+eOVm7Ybmhu4= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724921521; x=1725526321; 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=sgPHavE7K4ClGYJgJpC5pW6t6qCTjxay4H8VAVIO8qM=; b=auVten/JNOiLlsiAylH4FSGBhUPWT/OsFO6vmz1nnWlIHjAdUGXMYg0QaYuqXOGXdn 4miUkrWWkqMvRtoj6VNBb42MJ8HU/68tiUhnF6nsFtVQL1U9R5XAx6vqbY46rGEa2yEh xPGXgVLJeZzfNetk0itBMb8nEVY8zKW9mDcrFyBII34TrviFgHahwqo0zV539mVMW/fO wLXIdufo6LLmwFt4Z5m1PnM1ondY6N+mq7ZP3MXY8WmUEbe97YPsWxLPngpONpHViCPV aiEYt6Y+NsYqPsq0FULx0ZiinYe6zrQO6Mr0U6dBMIerk0ltyEF2PGOgTertpgJfrLCy y3nQ== X-Forwarded-Encrypted: i=1; AJvYcCUgzS5gQA+8RcEZiGB8mA6vn/aWrohwYZQP5+EBE9Uo70jQYkjEyi2ZqnK94TbnWOaewjn28nvQ4Mi+GBCS+/zS@lists.infradead.org X-Gm-Message-State: AOJu0Yx6HyQoA8WmeD1uMjXj8UDLEgE3RMEbsJnZ/Sz9T+YKMfixC1Uw x1+RjeXC6xbRklp/311pHzfA919J5zuXHY1BKLkIvNUFbk1Cuaevi9X1PMzL2Q== X-Google-Smtp-Source: AGHT+IHNUXOidI2Jf1faocA3YuPGFcSZUSZSENW9FgWaOxjFlPiWIkyXqvj6UuCHYbxvh0ZYtCh0GA== X-Received: by 2002:a17:902:d4c2:b0:1fd:a0b9:2be7 with SMTP id d9443c01a7336-2050c33e3eamr25630315ad.13.1724921520981; Thu, 29 Aug 2024 01:52:00 -0700 (PDT) Received: from wenstp920.tpe.corp.google.com ([2401:fa00:1:10:fbe5:6d6c:1cc7:23f3]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-20515543fbdsm6924165ad.218.2024.08.29.01.51.59 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 29 Aug 2024 01:52:00 -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 v2 06/10] regulator: fixed: Fix incorrectly formatted kerneldoc "Return" section Date: Thu, 29 Aug 2024 16:51:26 +0800 Message-ID: <20240829085131.1361701-7-wenst@chromium.org> X-Mailer: git-send-email 2.46.0.295.g3b9ea8a38a-goog In-Reply-To: <20240829085131.1361701-1-wenst@chromium.org> References: <20240829085131.1361701-1-wenst@chromium.org> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20240829_015201_900222_07772F2F X-CRM114-Status: GOOD ( 14.13 ) 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 kerneldoc of of_get_fixed_voltage_config(). The kerneldoc has a description about the return values, just not in the format kernel-doc wants. Convert it to use the proper "Return:" section header. The existing description have been reworded and moved around to fit the grammar and formatting. Signed-off-by: Chen-Yu Tsai --- Changes since v1: - Capitalized first word of first sentence in "Return" section - Added articles ("the", "a") to the description based on surrounding and function implementation context - s/alloc/allocation/ --- drivers/regulator/fixed.c | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/drivers/regulator/fixed.c b/drivers/regulator/fixed.c index cb93e5cdcfa9..c3de9c783d26 100644 --- a/drivers/regulator/fixed.c +++ b/drivers/regulator/fixed.c @@ -158,8 +158,10 @@ static int reg_fixed_get_irqs(struct device *dev, * @desc: regulator description * * Populates fixed_voltage_config structure by extracting data from device - * tree node, returns a pointer to the populated structure of NULL if memory - * alloc fails. + * tree node. + * + * Return: Pointer to a populated &struct fixed_voltage_config or %NULL if + * memory allocation fails. */ static struct fixed_voltage_config * of_get_fixed_voltage_config(struct device *dev,