| Message ID | 20240827095550.675018-1-wenst@chromium.org (mailing list archive) |
|---|---|
| Headers | show |
| Series | regulator: kerneldoc section fixes | expand |
On Tue, Aug 27, 2024 at 05:55:40PM +0800, Chen-Yu Tsai wrote: > Hi, > > Here are a bunch of kerneldoc fixes for the regulator core. This sort of > came as a request from Andy to not move code that already had warnings You can add Reported-by: or Suggested-by to the cover letter. > 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. > These are purely kerneldoc fixes and don't touch any actual code. I left > the devres code and helpers alone for now. Thanks for doing this! I briefly looked at them, the main two remarks are: 1) definite vs. indefinite article; 2) same and consistent term for negative error codes (or numbers if you prefer). Otherwise LGTM!
Hi, Here are a bunch of kerneldoc fixes for the regulator core. This 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. These are purely kerneldoc fixes and don't touch any actual code. I left the devres code and helpers alone for now. 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 (8): 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: Add missing "Return" kerneldoc section drivers/regulator/core.c | 175 ++++++++++++++++++++++--------- drivers/regulator/fixed-helper.c | 2 + drivers/regulator/fixed.c | 6 +- drivers/regulator/irq_helpers.c | 4 + drivers/regulator/of_regulator.c | 14 +-- 5 files changed, 141 insertions(+), 60 deletions(-)