diff mbox series

[v3,2/2] doc: Update netconsole examples, mention stderr

Message ID 20240518104706.25283-2-fiona.klute@gmx.de
State Accepted, archived
Delegated to: Heinrich Schuchardt
Headers show
Series [v3,1/2] doc: Detailed example for netconsole setup | expand

Commit Message

Fiona Klute May 18, 2024, 10:47 a.m. UTC 
Stderr was missing from the initial description and example.

As I understand the env command documentation the subcommand style is
preferred, though the old format is still fully supported.

Signed-off-by: Fiona Klute <fiona.klute@gmx.de>
Reviewed-by: Tony Dinh <mibodhi@gmail.com>
Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
Changes in v2:
* Mention stderr redirection
* Use 4 spaces instead of tabs for code block to avoid overflowing
  lines
Changes in v3:
* Use ".. prompt::" to make copying example commands easier

 doc/usage/netconsole.rst | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

--
2.43.0
diff mbox series

Patch

diff --git a/doc/usage/netconsole.rst b/doc/usage/netconsole.rst
index cb9a42d918..df27b78342 100644
--- a/doc/usage/netconsole.rst
+++ b/doc/usage/netconsole.rst
@@ -3,10 +3,10 @@  Network console

 In U-Boot, we implemented the networked console via the standard
 "devices" mechanism, which means that you can switch between the
-serial and network input/output devices by adjusting the 'stdin' and
-'stdout' environment variables. To switch to the networked console,
-set either of these variables to "nc". Input and output can be
-switched independently.
+serial and network input/output devices by adjusting the 'stdin',
+'stdout', and 'stderr' environment variables. To switch to the
+networked console, set either of these variables to "nc". Input and
+output can be switched independently.

 The default buffer size can be overridden by setting
 CFG_NETCONSOLE_BUFFER_SIZE.
@@ -22,12 +22,14 @@  configured by setting the 'ncoutport' environment variable. Note that
 you need to set up the network interface (e.g. using DHCP) before it
 can be used for network console.

-For example, if your server IP is 192.168.1.1, you could use::
+For example, if your server IP is 192.168.1.1, you could use:

-	=> setenv nc 'setenv stdout nc;setenv stdin nc'
-	=> setenv ncip 192.168.1.1
-	=> saveenv
-	=> run nc
+.. prompt:: bash =>
+
+    env set nc 'env set stdout nc; env set stderr nc; env set stdin nc'
+    env set ncip '192.168.1.1'
+    env save
+    run nc

 On the host side, please use this script to access the console