[PATCH] doc: cmd: loady: Document new configuration

[PATCH] doc: cmd: loady: Document new configuration

[Pali Rohár]

Signed-off-by: Pali Rohár <pali@kernel.org>
---
 doc/usage/cmd/loady.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/usage/cmd/loady.rst b/doc/usage/cmd/loady.rst
index 2819cc72aef4..718af6e128d5 100644
--- a/doc/usage/cmd/loady.rst
+++ b/doc/usage/cmd/loady.rst
@@ -61,6 +61,13 @@ Configuration
 
 The command is only available if CONFIG_CMD_LOADB=y.
 
+Initial timeout in seconds while waiting for transfer is configured by
+config option CMD_LOADXY_TIMEOUT or by env variable $loadxy_timeout.
+Setting it to 0 means infinite timeout.
+
+Transfer can be cancelled by pressing 3 times <CTRL+C> after two seconds
+of inactivity on terminal.
+
 Return value
 ------------
 
-- 
2.20.1

Re: [PATCH] doc: cmd: loady: Document new configuration

[Heinrich Schuchardt]

On 8/29/22 17:36, Pali Rohár wrote:
> Signed-off-by: Pali Rohár <pali@kernel.org>
> ---
>   doc/usage/cmd/loady.rst | 7 +++++++
>   1 file changed, 7 insertions(+)
>
> diff --git a/doc/usage/cmd/loady.rst b/doc/usage/cmd/loady.rst
> index 2819cc72aef4..718af6e128d5 100644
> --- a/doc/usage/cmd/loady.rst
> +++ b/doc/usage/cmd/loady.rst
> @@ -61,6 +61,13 @@ Configuration
>
>   The command is only available if CONFIG_CMD_LOADB=y.
>
> +Initial timeout in seconds while waiting for transfer is configured by
> +config option CMD_LOADXY_TIMEOUT or by env variable $loadxy_timeout.

Thanks for updating the documentation.

I assume CONFIG_CMD_LOADXY_TIMEOUT is the fallback if $loadxy_timeout is
not set? Maybe we can make this clearer here. Otherwise looks good to me.

Best regards

Heinrich


> +Setting it to 0 means infinite timeout.
> +
> +Transfer can be cancelled by pressing 3 times <CTRL+C> after two seconds
> +of inactivity on terminal.
> +
>   Return value
>   ------------
>

Re: [PATCH] doc: cmd: loady: Document new configuration

[Pali Rohár]

On Monday 29 August 2022 17:43:43 Heinrich Schuchardt wrote:
> On 8/29/22 17:36, Pali Rohár wrote:
> > Signed-off-by: Pali Rohár <pali@kernel.org>
> > ---
> >   doc/usage/cmd/loady.rst | 7 +++++++
> >   1 file changed, 7 insertions(+)
> > 
> > diff --git a/doc/usage/cmd/loady.rst b/doc/usage/cmd/loady.rst
> > index 2819cc72aef4..718af6e128d5 100644
> > --- a/doc/usage/cmd/loady.rst
> > +++ b/doc/usage/cmd/loady.rst
> > @@ -61,6 +61,13 @@ Configuration
> > 
> >   The command is only available if CONFIG_CMD_LOADB=y.
> > 
> > +Initial timeout in seconds while waiting for transfer is configured by
> > +config option CMD_LOADXY_TIMEOUT or by env variable $loadxy_timeout.
> 
> Thanks for updating the documentation.
> 
> I assume CONFIG_CMD_LOADXY_TIMEOUT is the fallback if $loadxy_timeout is
> not set? Maybe we can make this clearer here. Otherwise looks good to me.

Yes, CONFIG_CMD_LOADXY_TIMEOU is the default value which can be
overridden by $loadxy_timeout at runtime.

> Best regards
> 
> Heinrich
> 
> 
> > +Setting it to 0 means infinite timeout.
> > +
> > +Transfer can be cancelled by pressing 3 times <CTRL+C> after two seconds
> > +of inactivity on terminal.
> > +
> >   Return value
> >   ------------
> > 
> 

Re: [PATCH] doc: cmd: loady: Document new configuration

[Tom Rini]

[-- Attachment #1: Type: text/plain, Size: 157 bytes --]

On Mon, Aug 29, 2022 at 05:36:23PM +0200, Pali Rohár wrote:

> Signed-off-by: Pali Rohár <pali@kernel.org>

Applied to u-boot/next, thanks!

-- 
Tom

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 659 bytes --]