From patchwork Thu Jun 25 20:50:53 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 11627243 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id E7237913 for ; Fri, 26 Jun 2020 11:28:43 +0000 (UTC) Received: from merlin.infradead.org (merlin.infradead.org [205.233.59.134]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id A8A2A206A1 for ; Fri, 26 Jun 2020 11:28:43 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="cdgvzO9L"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="OKh2/XCT"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="SHhYBkJi" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org A8A2A206A1 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=merlin.20170209; h=Sender:Content-Transfer-Encoding: Content-Type:Cc:List-Subscribe:List-Help:List-Post:List-Archive: List-Unsubscribe:List-Id:MIME-Version:Message-Id:Date:Subject:To:From: Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender :Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:References:List-Owner; bh=0u+OPsHaCkGVOPmp4RTV06YupMgfXQzpGYnhhvTWIBE=; b=cdgvzO9LeA0Bz3z6amB2DKE+ka ZRXbtNtJx1FQt307vSKXhrNrUcooRAgaAE0MzDoeC2Xf3pbahFxKpbc75O6x/ESybMn3/NLc+qNx/ BmpCuWaX1Y5aeXpCOSvbEVwkLs2VypAhHnoMavpP+0kinRIo4ObmRB2CFH3lmEbnSsXqwgRmJb2WQ nMhU5TWYenZPiltFWPMPPd/d8y2zKqDRr6ZqYTYm4+Xd7imd6+CqAgq7dlVLmrQOHsv8KtXihg1nI 46/GW69mDjRoMH5vrWRjk5AqOvD/inyXpuRpxpQ06WQA6xX7yDMyhaNNZOom6w6ILjD5NnjB3atS+ RsC4B39A==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jomVI-0002ZM-ME; Fri, 26 Jun 2020 11:26:44 +0000 Received: from casper.infradead.org ([90.155.50.34]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jolFA-0000YK-NQ for linux-arm-kernel@merlin.infradead.org; Fri, 26 Jun 2020 10:06:00 +0000 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; h=Content-Transfer-Encoding:MIME-Version: Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type:Content-ID: Content-Description:In-Reply-To:References; bh=Ju1U+tPndCh0ArRsOyQQP1OuDrYeOK89CttbwD+tA2w=; b=OKh2/XCT41lQuaQPeHjBRwvMHn Kx0OFG6GYsmJDvnPgf3fcwWVdMpEcpI2ZcsO7OlRc8IGLSLnuN8m9GQRAlG8AaSsQ/SfroEp7utDP tJ1ytRjeD6PwwUXS7jE+yfdEMh4QuQCv7szWUmOeGnwOklu8WTRTkUnaArwM2TMVWFLaaUeFunshP 3/XiU3CMnnXfnYcmLyQZKL6cK3Jpk3ZvMYY1fu9Gm1yFFX7PJVKbjkjizOTYdSFt3vEIdgnyOhlxF g0cUm9lS3+X+1GvrNdv7Exqrx2i9vbVVYm6t66kQRfUl6CjEQwIYHLn406sLx4Bl7jcFsB8jOfkIP clp8fqlw==; Received: from mail-wm1-x341.google.com ([2a00:1450:4864:20::341]) by casper.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jolEb-0004ql-A5 for linux-arm-kernel@lists.infradead.org; Fri, 26 Jun 2020 10:05:55 +0000 Received: by mail-wm1-x341.google.com with SMTP id 17so8813790wmo.1 for ; Fri, 26 Jun 2020 03:05:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=Ju1U+tPndCh0ArRsOyQQP1OuDrYeOK89CttbwD+tA2w=; b=SHhYBkJiwdDam4QgitQRrlJfKsdLwmI7uPhVCNqSaOV5WVwl3dCAW4UlsO4aFnymiy Ly9hBiXqNGFi8qSWwCfpJLQanD3/FB/mSdYlIZL7hEhDi9HEgRVOiMxryU4HUKaDZAOH qoB3RuIvQV4MoUZ4/UwqleSRJFVp88zMKIo+QFQuQ+6P4tnn87vhdXnOkikNTY5XYL32 lAxXNQLKzg/qeuUUZmdc/7Hv1MNNnhfEAtlynSuaupW45OTPZjzr1j6A6567GodiiRBC IVdkHGyreyxu6WiHWPKv6Tq08d0FEaKnHG4UOMOq3itViht9CfIC/b1tXSdd5+LumZ/2 EjxA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=Ju1U+tPndCh0ArRsOyQQP1OuDrYeOK89CttbwD+tA2w=; b=RW4k+LfeCD3W/Gk/obzfDdKLMu039vU5JOPdoAA1BPoTSwMLUHtdHDuSuCeyM+Dt7K 4OXCKPbKpg9sbASe1lTjKsBVv37hKgIzvILXJcezW7GZXJ/a8nTetn+DS4iNvMD34p64 uSZkpHcXN7xLOrJVlvHlcagwzMyPPxcpksoDXz0ewyxYGUSsx+EbD7Ew5gDTst5s04gs PchEHwZIGYaR2RMlbctPVMQyy4XoO8tX4nKO49B4ngGnDJFwiOYPrsB51D9YQP5ASoa6 y5RXdGZxAwnuZP94MoH9pRTkP/eWo+7R1n8w1v9DskPzYvhoi8pQv+cMBU0OnhV/iepz Zygw== X-Gm-Message-State: AOAM5314yKH0rcD9Ub+EC0v9APti7aZ7UAxiF3zU0XTc2CY0znMPNlhc nBS66HW86d1YwZHP5ql3DE5alEossdEeiw== X-Google-Smtp-Source: ABdhPJxbJCYoIUbP86SyUwiFATrrWaKC2ZDlF8UdEPr7tYWahscflEno7v16wZ9J7yJXIYTaNLBepQ== X-Received: by 2002:a7b:c7d2:: with SMTP id z18mr5493720wmk.149.1593118285933; Thu, 25 Jun 2020 13:51:25 -0700 (PDT) Received: from localhost.localdomain ([2.27.35.144]) by smtp.gmail.com with ESMTPSA id r3sm13960263wrg.70.2020.06.25.13.51.24 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 25 Jun 2020 13:51:25 -0700 (PDT) From: Lee Jones To: broonie@kernel.org, lgirdwood@gmail.com Subject: [PATCH 1/1] regulator: devres: Standardise on function documentation headers Date: Thu, 25 Jun 2020 21:50:53 +0100 Message-Id: <20200625205053.4191910-1-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20200626_110526_016010_45DEAA2C X-CRM114-Status: GOOD ( 14.93 ) X-Spam-Score: -2.1 (--) X-Spam-Report: SpamAssassin version 3.4.4 on casper.infradead.org summary: Content analysis details: (-2.1 points, 5.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- -0.0 RCVD_IN_DNSWL_NONE RBL: Sender listed at https://www.dnswl.org/, no trust [2a00:1450:4864:20:0:0:0:341 listed in] [list.dnswl.org] -1.9 BAYES_00 BODY: Bayes spam probability is 0 to 1% [score: 0.0000] -0.0 SPF_PASS SPF: sender matches SPF record 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature -0.1 DKIM_VALID_EF Message has a valid DKIM or DK signature from envelope-from domain -0.1 DKIM_VALID_AU Message has a valid DKIM or DK signature from author's domain 0.1 DKIM_SIGNED Message has a DKIM or DK signature, not necessarily valid X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Lee Jones , linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org Line up descriptions, start description with a lower-case character and omit old definitions such as quoting the old argument "consumer". Signed-off-by: Lee Jones --- drivers/regulator/devres.c | 52 +++++++++++++++++++------------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/drivers/regulator/devres.c b/drivers/regulator/devres.c index 3f73ce8590007..3091210889e31 100644 --- a/drivers/regulator/devres.c +++ b/drivers/regulator/devres.c @@ -41,8 +41,8 @@ static struct regulator *_devm_regulator_get(struct device *dev, const char *id, /** * devm_regulator_get - Resource managed regulator_get() - * @dev: device for regulator "consumer" - * @id: Supply name or regulator ID. + * @dev: device to supply + * @id: supply name or regulator ID. * * Managed regulator_get(). Regulators returned from this function are * automatically regulator_put() on driver detach. See regulator_get() for more @@ -56,8 +56,8 @@ EXPORT_SYMBOL_GPL(devm_regulator_get); /** * devm_regulator_get_exclusive - Resource managed regulator_get_exclusive() - * @dev: device for regulator "consumer" - * @id: Supply name or regulator ID. + * @dev: device to supply + * @id: supply name or regulator ID. * * Managed regulator_get_exclusive(). Regulators returned from this function * are automatically regulator_put() on driver detach. See regulator_get() for @@ -72,8 +72,8 @@ EXPORT_SYMBOL_GPL(devm_regulator_get_exclusive); /** * devm_regulator_get_optional - Resource managed regulator_get_optional() - * @dev: device for regulator "consumer" - * @id: Supply name or regulator ID. + * @dev: device to supply + * @id: supply name or regulator ID. * * Managed regulator_get_optional(). Regulators returned from this * function are automatically regulator_put() on driver detach. See @@ -130,9 +130,9 @@ static void devm_regulator_bulk_release(struct device *dev, void *res) /** * devm_regulator_bulk_get - managed get multiple regulator consumers * - * @dev: Device to supply - * @num_consumers: Number of consumers to register - * @consumers: Configuration of consumers; clients are stored here. + * @dev: device to supply + * @num_consumers: number of consumers to register + * @consumers: configuration of consumers; clients are stored here. * * @return 0 on success, an errno on failure. * @@ -173,9 +173,9 @@ static void devm_rdev_release(struct device *dev, void *res) /** * devm_regulator_register - Resource managed regulator_register() - * @dev: device to supply + * @dev: device to supply * @regulator_desc: regulator to register - * @config: runtime configuration for regulator + * @config: runtime configuration for regulator * * Called by regulator drivers to register a regulator. Returns a * valid pointer to struct regulator_dev on success or an ERR_PTR() on @@ -259,10 +259,10 @@ static void devm_regulator_destroy_supply_alias(struct device *dev, void *res) * devm_regulator_register_supply_alias - Resource managed * regulator_register_supply_alias() * - * @dev: device that will be given as the regulator "consumer" - * @id: Supply name or regulator ID + * @dev: device to supply + * @id: supply name or regulator ID * @alias_dev: device that should be used to lookup the supply - * @alias_id: Supply name or regulator ID that should be used to lookup the + * @alias_id: supply name or regulator ID that should be used to lookup the * supply * * The supply alias will automatically be unregistered when the source @@ -300,8 +300,8 @@ EXPORT_SYMBOL_GPL(devm_regulator_register_supply_alias); * devm_regulator_unregister_supply_alias - Resource managed * regulator_unregister_supply_alias() * - * @dev: device that will be given as the regulator "consumer" - * @id: Supply name or regulator ID + * @dev: device to supply + * @id: supply name or regulator ID * * Unregister an alias registered with * devm_regulator_register_supply_alias(). Normally this function @@ -327,12 +327,12 @@ EXPORT_SYMBOL_GPL(devm_regulator_unregister_supply_alias); * devm_regulator_bulk_register_supply_alias - Managed register * multiple aliases * - * @dev: device that will be given as the regulator "consumer" - * @id: List of supply names or regulator IDs + * @dev: device to supply + * @id: list of supply names or regulator IDs * @alias_dev: device that should be used to lookup the supply - * @alias_id: List of supply names or regulator IDs that should be used to - * lookup the supply - * @num_id: Number of aliases to register + * @alias_id: list of supply names or regulator IDs that should be used to + * lookup the supply + * @num_id: number of aliases to register * * @return 0 on success, an errno on failure. * @@ -377,9 +377,9 @@ EXPORT_SYMBOL_GPL(devm_regulator_bulk_register_supply_alias); * devm_regulator_bulk_unregister_supply_alias - Managed unregister * multiple aliases * - * @dev: device that will be given as the regulator "consumer" - * @id: List of supply names or regulator IDs - * @num_id: Number of aliases to unregister + * @dev: device to supply + * @id: list of supply names or regulator IDs + * @num_id: number of aliases to unregister * * Unregister aliases registered with * devm_regulator_bulk_register_supply_alias(). Normally this function @@ -423,7 +423,7 @@ static void devm_regulator_destroy_notifier(struct device *dev, void *res) * regulator_register_notifier * * @regulator: regulator source - * @nb: notifier block + * @nb: notifier block * * The notifier will be registers under the consumer device and be * automatically be unregistered when the source device is unbound. @@ -460,7 +460,7 @@ EXPORT_SYMBOL_GPL(devm_regulator_register_notifier); * regulator_unregister_notifier() * * @regulator: regulator source - * @nb: notifier block + * @nb: notifier block * * Unregister a notifier registered with devm_regulator_register_notifier(). * Normally this function will not need to be called and the resource