| Message ID | 20240829085131.1361701-1-wenst@chromium.org (mailing list archive) |
|---|---|
| Headers | show |
| Series | regulator: kerneldoc section fixes | expand |
On Thu, Aug 29, 2024 at 04:51:20PM +0800, Chen-Yu Tsai wrote: > 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. > 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. Instead of or in addition to this, please use --base parameter when formatting patch series. > Please merge if possible. > I will rebase my I2C OF component prober series [1] on top of them. Briefly looked again and all seems all right with some nit-picks, that I have already sent individually. Since Mark acknowledged English, I believe it's fine to go. Reported-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com> Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
On Thu, 29 Aug 2024 16:51:20 +0800, Chen-Yu Tsai wrote: > 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. > > [...] Applied to https://git.kernel.org/pub/scm/linux/kernel/git/broonie/regulator.git for-next Thanks! [01/10] regulator: core: Fix short description for _regulator_check_status_enabled() commit: caa08dd8cdb8e58bf810e986cd6f9081ad056018 [02/10] regulator: core: Fix regulator_is_supported_voltage() kerneldoc return value commit: 753b9d86adb9d2c5882ac8ee0c3816aa48697eaa [03/10] regulator: core: Fix incorrectly formatted kerneldoc "Return" sections commit: f746af13dd115ae3e0ec9d762baa170184401d41 [04/10] regulator: core: Add missing kerneldoc "Return" sections commit: 4ac204ff2d4ec360d9d2e39840ad286ddb78439f [05/10] regulator: of: Fix incorrectly formatted kerneldoc "Return" sections commit: dac41d59f2de25b8d3f5350c8cbfe39187d214da [06/10] regulator: fixed: Fix incorrectly formatted kerneldoc "Return" section commit: 5f93c59e607e6f28eef2ed7ddd5a2f89abc943a5 [07/10] regulator: fixed-helper: Add missing "Return" kerneldoc section commit: 4ddb16cf5390fc8546409aab3c69ffe6651b3c6b [08/10] regulator: irq_helpers: Fix regulator_irq_map_event_simple() kerneldoc commit: 77904c81703b7a4a929abafb837d06b49de087e6 [09/10] regulator: of: Fix kerneldoc format for of_regulator_bulk_get_all() commit: 6eace77a6048c9b0b50950e88ef987d4519a53c1 [10/10] regulator: Unify "negative error number" terminology in comments commit: 98ce82a52886edd5197e903cb2b56f21bf3b0781 All being well this means that it will be integrated into the linux-next tree (usually sometime in the next 24 hours) and sent to Linus during the next merge window (or sooner if it is a bug fix), however if problems are discovered then the patch may be dropped or reverted. You may get further e-mails resulting from automated or manual testing and review of the tree, please engage with people reporting problems and send followup patches addressing any issues that are reported if needed. If any updates are required or you are submitting further changes they should be sent as incremental updates against current git, existing patches will not be replaced. Please add any relevant lists and maintainers to the CCs when replying to this mail. Thanks, Mark
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(-)