doc: cmd: loady: Document new configuration
PATCH 1/1 doc: cmd: loady: Document new configuration
Signed-off-by Pali Rohár <[email protected]>
--- doc/usage/cmd/loady.rst | 7 +++++++ 1 file changed, 7 insertions(+)
doc/usage/cmd/loady.rst +7 -0
@@ -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 ------------
Signature · 1 line
2.20.1
Quoted 10 lines · Pali Rohár
Signed-off-by Pali Rohár <[email protected]>--- doc/usage/cmd/loady.rst | 7 +++++++ 1 file changed, 7 insertions(+)doc/usage/cmd/loady.rst +0
-0
doc/usage/cmd/loady.rst Configuration · line 65
Quoted 5 lines
doc/usage/cmd/loady.rst +2
-0@@ -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
Quoted 8 lines
doc/usage/cmd/loady.rst +5
-0+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 ------------
Quoted 14 lines · On Monday 29 August 2022 17:43:43 Heinrich Schuchardt wrote:
Quoted 13 lines · Pali Rohár
Signed-off-by Pali Rohár <[email protected]>--- doc/usage/cmd/loady.rst | 7 +++++++ 1 file changed, 7 insertions(+)doc/usage/cmd/loady.rst +0
-0@@ -61,6 +61,13 @@ Configuration The command is only available if CONFIG_CMD_LOADB=y.
Quoted 7 lines
doc/usage/cmd/loady.rst Configuration · line 65
Quoted 2 lines
doc/usage/cmd/loady.rst +2
-0+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_TIMEOUTis 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.
Quoted 14 lines
Best regards
Heinrich
Quoted 8 lines
doc/usage/cmd/loady.rst +5
-0+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 ------------
Quoted 1 line · Pali Rohár
Signed-off-by Pali Rohár <[email protected]>
Applied to u-boot/next, thanks!
Signature · 1 line
Tom