OSDN Git Service

pwm: Reword docs about pwm_apply_state()
authorUwe Kleine-König <u.kleine-koenig@pengutronix.de>
Fri, 23 Apr 2021 16:32:26 +0000 (18:32 +0200)
committerThierry Reding <thierry.reding@gmail.com>
Mon, 26 Apr 2021 06:49:48 +0000 (08:49 +0200)
commita6efb35019d00f483a0e5f188747723371d659fe
tree5fa637b022fb3adc2eb716caf22747553ccee5fb
parent8035e6c66a5e98f098edf7441667de74affb4e78
pwm: Reword docs about pwm_apply_state()

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@pengutronix.de/
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: 1a7a6e8072ea ("pwm: Clarify which state pwm_get_state() returns")
Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
Signed-off-by: Thierry Reding <thierry.reding@gmail.com>
Documentation/driver-api/pwm.rst