Skip to contentSkip to conversation

doc: cmd: loady: Document new configuration

PATCH In review Pali Rohár 3 participants 4 messages Aug 29, 2022 – Sep 15, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: cmd: loady: Document new configuration

---
 doc/usage/cmd/loady.rst | 7 +++++++
 1 file changed, 7 insertions(+)
doc/usage/cmd/loady.rst +7 -0
index 2819cc72aef4..718af6e128d5 100644
@@ -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
#1 lore raw
Quoted 10 lines · Pali Rohár
---
  doc/usage/cmd/loady.rst | 7 +++++++
  1 file changed, 7 insertions(+)
doc/usage/cmd/loady.rst +0 -0
index 2819cc72aef4..718af6e128d5 100644

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
  ------------
 
#2 lore raw
Quoted 14 lines · On Monday 29 August 2022 17:43:43 Heinrich Schuchardt wrote:
Quoted 13 lines · Pali Rohár
---
  doc/usage/cmd/loady.rst | 7 +++++++
  1 file changed, 7 insertions(+)
doc/usage/cmd/loady.rst +0 -0
index 2819cc72aef4..718af6e128d5 100644
@@ -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_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.

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
  ------------