[PATCH v3] doc: document the pwm command

Quentin Schulz quentin.schulz at cherry.de
Thu Aug 1 12:33:25 CEST 2024


Hi Emil,

On 8/1/24 12:07 PM, Emil Kronborg wrote:
> Signed-off-by: Emil Kronborg <emil.kronborg at protonmail.com>
> ---
> Changes in v3:
> - The help text for 'pwm config' in the examples section is more
>    explicit about 20 us and 14 us for the period and duty cycle,
>    respectively.
> - Fixed 'pwm enable' and 'pwm disable' in the examples section to only
>    expect 2 arguments.
> - Rebased on top of master.
> 
>   doc/usage/cmd/pwm.rst | 80 +++++++++++++++++++++++++++++++++++++++++++
>   doc/usage/index.rst   |  1 +
>   2 files changed, 81 insertions(+)
>   create mode 100644 doc/usage/cmd/pwm.rst
> 
> diff --git a/doc/usage/cmd/pwm.rst b/doc/usage/cmd/pwm.rst
> new file mode 100644
> index 000000000000..bd1255d82186
> --- /dev/null
> +++ b/doc/usage/cmd/pwm.rst
> @@ -0,0 +1,80 @@
> +.. SPDX-License-Identifier: GPL-2.0+:

This isn't a valid identifier (spurious ':') I believe.

Also, I would highly suggest to change it to GPL-2.0-or-later which is 
the current naming scheme for the same license, c.f. 
https://spdx.org/licenses/

Otherwise, looking good so with that changed:

Reviewed-by: Quentin Schulz <quentin.schulz at cherry.de>

Thanks!
Quentin


More information about the U-Boot mailing list