Re: linux-next: build warning after merge of the pwm tree

[Uwe Kleine-König]

hello,

On Thu, Apr 17, 2025 at 04:27:00PM +1000, Stephen Rothwell wrote:
> After merging the pwm tree, today's linux-next build (htmldocs) produced
> this warning:
> 
> ocumentation/driver-api/miscellaneous:47: drivers/pwm/core.c:232: WARNING: Inline emphasis start-string without end-string. [docutils]
> 
> Introduced by commit
> 
>   bde5547f2e87 ("pwm: Better document return value of pwm_round_waveform_might_sleep()")

I squashed a fix into that commit:

$ git range-diff bde5547f2e87...fbf1880bada0
1:  bde5547f2e87 ! 1:  fbf1880bada0 pwm: Better document return value of pwm_round_waveform_might_sleep()
    @@ Commit message

         Signed-off-by: Uwe Kleine-König <u.kleine-koenig@xxxxxxxxxxxx>
         Link: https://lore.kernel.org/r/db84abf1e82e4498fc0e7c318d2673771d0039fe.1744120697.git.ukleinek@xxxxxxxxxx
    +    [ukleinek: Fix a rst formatting issue reported by Stephen Rothwell]
         Signed-off-by: Uwe Kleine-König <ukleinek@xxxxxxxxxx>

      ## drivers/pwm/core.c ##
    @@ drivers/pwm/core.c: static int __pwm_write_waveform(struct pwm_chip *chip, struc
       *
     - * Returns 0 on success, 1 if there is no valid hardware configuration matching
     - * the input waveform under the PWM rounding rules or a negative errno.
    -+ * Usually all values passed in *wf are rounded down to the nearest possible
    ++ * Usually all values passed in @wf are rounded down to the nearest possible
     + * value (in the order period_length_ns, duty_length_ns and then
     + * duty_offset_ns). Only if this isn't possible, a value might grow.
     + *

Thanks for the report (and all the work you do to notice these issues)!

Best regards
Uwe

Attachment: signature.asc
Description: PGP signature