Re: [PATCH] pwm: reword docs about pwm_apply_state()

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 4/23/21 12:44 AM, Uwe Kleine-König wrote:
> The main issue is that the current documentation talks about the
> non-existent function pwm_get_last_applied_state. (This was right in the
> context of
> https://lore.kernel.org/linux-pwm/20210406073036.26857-1-u.kleine-koenig@xxxxxxxxxxxxxx/
> but was then missed to adapt when this patch was reduced to a
> documentation update.)
> 
> While at is also clarify "last applied PWM state" to "PWM state that was
> passed to the last invocation of pwm_apply_state()" to better
> distinguish to the last actually implemented state and reword to drop a
> word repetition.
> 
> Fixes: 539ed98e2bd3 ("pwm: Clarify documentation about pwm_get_state()")
> Signed-off-by: Uwe Kleine-König <u.kleine-koenig@xxxxxxxxxxxxxx>
> ---
>  Documentation/driver-api/pwm.rst | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/driver-api/pwm.rst b/Documentation/driver-api/pwm.rst
> index 381f3c46cdac..a7ca4f58305a 100644
> --- a/Documentation/driver-api/pwm.rst
> +++ b/Documentation/driver-api/pwm.rst
> @@ -55,11 +55,11 @@ several parameter at once. For example, if you see pwm_config() and
> pwm_{enable,disable}() calls in the same function, this probably means you
> should switch to pwm_apply_state().
> 
> The PWM user API also allows one to query the[-last applied-] PWM state [-with-]
> [-pwm_get_last_applied_state().-]{+that was passed to the+}
> {+last invocation of pwm_apply_state() using pwm_get_state().+} Note this is
> different to what the driver has actually implemented if the request cannot be
> [-implemented-]{+satisfied+} exactly with the hardware in use. There is currently no way for
> consumers to get the actually implemented settings.
> 
> In addition to the PWM state, the PWM API also exposes PWM arguments, which
> are the reference PWM config one should use on this PWM.
> 
> base-commit: 64d7d074acd52e1bdff621f2cb86c0aae9bcef80
> 

Looks like the patch got horribly word wrapped. ?

thanks.
-- 
~Randy




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux