]> git.dujemihanovic.xyz Git - u-boot.git/commitdiff
doc: Update netconsole examples, mention stderr
authorFiona Klute <fiona.klute@gmx.de>
Sat, 18 May 2024 10:47:06 +0000 (12:47 +0200)
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Thu, 6 Jun 2024 07:25:08 +0000 (09:25 +0200)
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>
doc/usage/netconsole.rst

index cb9a42d918aff38acdcbd1e30d918dad999883f3..df27b78342f38acd21281f118e97beb534ec9b06 100644 (file)
@@ -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