From patchwork Thu Aug 29 08:51:20 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: 13782798 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 8C11EC83010 for ; Thu, 29 Aug 2024 08:53:01 +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: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:In-Reply-To:References:List-Owner; bh=eIAeAASz/ZYrof6JHmNSUqvtaNF6cnHwnLCZxylqj3w=; b=0sJtzyX4gMdVmsLeD0VoXuzV7F rn6lsUGQQyIN9SBV0scXXqsjTz9wtm+ma5s0wQMgYrSxQkhEnQKqS+w+sSynfOapHuQblQf3qPuDc /g5IXrwWvhn9KcSknNG8L1AqBHg61DurGdHr9qnrVQMEiwLGF5Rc3lgEi9MlooQnoXT74Mrq7Y7oC FFfELcfM0/Isd16333R7j6SVHw+qr0u4RhJAfchFkCT19JFGAFHwFCoPVVRVDHerEWer1b5/yR7/M 4F+q24GcBDhTfBRuqN9BtkJqNwH+dJAQwiEQ1xZOzjNTS14AC1ydTNxy27Nuzk48S614M9Pq5z7cn GFWcRSRw==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.97.1 #2 (Red Hat Linux)) id 1sjatY-00000001E6y-0uI6; Thu, 29 Aug 2024 08:52:44 +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 1sjase-00000001Dnw-46O7 for linux-arm-kernel@lists.infradead.org; Thu, 29 Aug 2024 08:51:50 +0000 Received: by mail-pl1-x630.google.com with SMTP id d9443c01a7336-20202df1c2fso10764045ad.1 for ; Thu, 29 Aug 2024 01:51:48 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1724921507; x=1725526307; darn=lists.infradead.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=eIAeAASz/ZYrof6JHmNSUqvtaNF6cnHwnLCZxylqj3w=; b=MvSpPtYrRNV2Nn5RT4SOVc2OMIJnXHFgNgIaPbukswohjBQP/q21nmiWFI2cRYtyj6 PdpA0k7LyKXVb8WHyyYYrJIm+tUIKTDSfQwHarPcLYJdDzjGHYw+/Gla31tF7G5GhkWD XJFYwJqj1XATU2jx7PvFZ6lY4aIncGV7ulH70= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724921507; x=1725526307; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=eIAeAASz/ZYrof6JHmNSUqvtaNF6cnHwnLCZxylqj3w=; b=BDHT5nVg7eIBnesKT4BgCCQqFtcI2sDXLZ9t49rJ3sJg7m9VzMdcauD4vK6nSU6+yV 9txRqAmXi61RGlSZg3Y8+CLSYYQ/W2NN3pUVxTo4kZDGctG4dy0eJjpW+U0of6jrR2Go GPJQ35jwR3s4WflOQmPZ7nAjtjVTLwmKDu2a0MAG+/U1vt5MCIh21JFRkG5PBhzEfIg0 RLvQhH/QPDAv6AwOicjnELbWaKiulPqy01pnJYd+S5zyoN3lK+Xc2PblINA8TCmWfa8e 5upRlyHZB3trNPHsOix/IKbLDlyXlUwv78YgZZu9KVsx2ZL2nnXOHk6nqc8BHPB4DFV2 d+Iw== X-Forwarded-Encrypted: i=1; AJvYcCU9XgrpNKRMioWuJQUE0tn/ph5HZXHcwnpTUyB37tS9I5yKLu6T0fgfOoLZjZKrF9X7NIaFY3peKRdKpOwqUYwf@lists.infradead.org X-Gm-Message-State: AOJu0Yx9VKYfHZgbRQSVJo4cRV/+ib0RzfLqkRRb68JraJGjQJhCm1jb M/7EkDfTRMgv3xtpKu1C7XjUWzlqJWh6prSHdkBd/i4M9KuR9Ktt5I88wHbhQA== X-Google-Smtp-Source: AGHT+IGb9fFiKk0XqfZAGeXj9gAdeNWQ0xstFw+ZSWhcMFLXArgx8GV6bPpRRck/Rprv/rWAmDWHpg== X-Received: by 2002:a17:903:11d1:b0:202:3617:d52a with SMTP id d9443c01a7336-205166db944mr15710715ad.6.1724921507527; Thu, 29 Aug 2024 01:51:47 -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.45 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 29 Aug 2024 01:51:47 -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 00/10] regulator: kerneldoc section fixes Date: Thu, 29 Aug 2024 16:51:20 +0800 Message-ID: <20240829085131.1361701-1-wenst@chromium.org> X-Mailer: git-send-email 2.46.0.295.g3b9ea8a38a-goog MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20240829_015149_084251_E0747BF2 X-CRM114-Status: GOOD ( 16.09 ) 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 Hi, This is v2 of my regulator kerneldoc fixes series. The series sort of came as a request from Andy to not move code that already had warnings without fixing said warnings. So here I'm fixing them first. Changes since v1: - Replaced "true, false" with "valid return values" in commit message of "Fix regulator_is_supported_voltage() kerneldoc return value". - Added articles ("the", "a") to the description based on surrounding and function implementation context. - The indefinite article ("a", "an") is used when the return value can vary in the case of negative error numbers or when the returned pointer points to a newly allocated memory object. - The definite article ("the") is used when a specific return value is mentioned, or when the returned pointer points to some existing object. - Capitalized first word of first sentence in "Return" section. - Indented "Return" section for regulator_is_enabled(). - s/alloc/allocation/ - s/error code/error number/ - For patch 'regulator: irq_helpers: Add missing "Return" kerneldoc section': - Changed subject to "Fix regulator_irq_map_event_simple() kerneldoc". - Described output fields in @rid clearly. - Added patch to fix of_regulator_bulk_get_all() kerneldoc. - Added patch to align "negative error number" terminology. Link to v1: https://lore.kernel.org/all/20240827095550.675018-1-wenst@chromium.org/ The bulk of the fixes are in the regulator core and OF code, but I also fixed up a few bits in common code that were missing "Return" sections. There's also a final patch to align terminology around "negative error number" within the regulator subsystem. These are purely kerneldoc and comment fixes and don't touch any actual code. I left the devres code and helpers alone for now. The patch series is based on next-20240829. Please merge if possible. I will rebase my I2C OF component prober series [1] on top of them. Thanks ChenYu [1] https://lore.kernel.org/all/20240822092006.3134096-1-wenst@chromium.org/ Chen-Yu Tsai (10): regulator: core: Fix short description for _regulator_check_status_enabled() regulator: core: Fix regulator_is_supported_voltage() kerneldoc return value regulator: core: Fix incorrectly formatted kerneldoc "Return" sections regulator: core: Add missing kerneldoc "Return" sections regulator: of: Fix incorrectly formatted kerneldoc "Return" sections regulator: fixed: Fix incorrectly formatted kerneldoc "Return" section regulator: fixed-helper: Add missing "Return" kerneldoc section regulator: irq_helpers: Fix regulator_irq_map_event_simple() kerneldoc regulator: of: Fix kerneldoc format for of_regulator_bulk_get_all() regulator: Unify "negative error number" terminology in comments drivers/regulator/core.c | 178 +++++++++++++++++------- drivers/regulator/devres.c | 18 +-- drivers/regulator/fixed-helper.c | 2 + drivers/regulator/fixed.c | 8 +- drivers/regulator/irq_helpers.c | 17 ++- drivers/regulator/max77802-regulator.c | 4 +- drivers/regulator/of_regulator.c | 21 +-- drivers/regulator/qcom-rpmh-regulator.c | 6 +- drivers/regulator/qcom_smd-regulator.c | 2 +- 9 files changed, 170 insertions(+), 86 deletions(-) Reported-by: Andy Shevchenko Reviewed-by: Andy Shevchenko