Hi Petr,

On 2026-10-10T12:27:54, Petr Hodina via B4 Relay
<[email protected]> wrote:
> doc: button: document monitor subcommand
>
> Add the monitor subcommand to the synopsis, description and return
> value table of the button command page.
>
> Signed-off-by: Petr Hodina <[email protected]>
>
> doc/usage/cmd/button.rst | 16 ++++++++++++++++
>  1 file changed, 16 insertions(+)

> diff --git a/doc/usage/cmd/button.rst b/doc/usage/cmd/button.rst
> @@ -43,6 +44,19 @@ A list of all available buttons and their status can be 
> displayed using
> +This probes all buttons, clears the screen and shows a table of their status
> +in the same format as *button list* (*on*, *off*, *<inactive>* if probing 
> failed,
> +or an error code), refreshed every 100ms together with the remaining time. 
> The

The second line is 81 columns, so please can you rewrap this paragraph?

The command uses ANSI escapes to clear the screen and move the cursor,
so please can you say that it needs an ANSI-capable terminal? On a
plain serial log, or on a terminal that ignores the escapes, the
output is just one table after another. Please also add a short
Example section with typical output, as other pages in doc/usage/cmd
do.

Otherwise the description matches patch 1. Since uclass_probe_all()
runs first, '<inactive>' does mean the probe failed, and a bad timeout
and Ctrl-C both give the return values in the table.

Regards,
Simon

Reply via email to