[PATCH v4] doc: document the pwm command

Simon Glass sjg at chromium.org
Thu Aug 15 22:32:57 CEST 2024


On Thu, 15 Aug 2024 at 07:29, Emil Kronborg
<emil.kronborg at protonmail.com> wrote:
>
> Signed-off-by: Emil Kronborg <emil.kronborg at protonmail.com>
> ---
> Changes in v4:
> - Changed license from GPL-2.0+ to GPL-2.0-or-later. Also, removed
>   trailing colon.
> - Simplified the descriptions in the Synopsis section by removing the
>   text following the '-'.
> - Reformulated the description of the invert subcommand to be more
>   precise and correct.
> - %s/duty cycle/duty period to be consistent with pwm.h and to ensure
>   correctness, as duty cycle is dimensionless and <duty_ns> is given in
>   nanoseconds.
> - Moved the common parameters, pwm_dev_num and channel, to the bottom of
>   the Description section, and added the remaining parameters.
> - Added a comma in the Examples section and used 'µs' instead of 'us'.
> - Rebased on top of master.
>
>  doc/usage/cmd/pwm.rst | 91 +++++++++++++++++++++++++++++++++++++++++++
>  doc/usage/index.rst   |  1 +
>  2 files changed, 92 insertions(+)
>  create mode 100644 doc/usage/cmd/pwm.rst

Reviewed-by: Simon Glass <sjg at chromium.org>


More information about the U-Boot mailing list