diff mbox series

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

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

Commit Message

Fiona Klute May 16, 2024, 10:42 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>
---
Changes in v2:
* Mention stderr redirection
* Use 4 spaces instead of tabs for code block to avoid overflowing
  lines

 doc/usage/netconsole.rst | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

--
2.43.0

Comments

Tony Dinh May 16, 2024, 7:20 p.m. UTC | #1
Hi Fiona,

On Thu, May 16, 2024 at 3:43 AM Fiona Klute <fiona.klute@gmx.de> wrote:
>
> 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>
> ---
> Changes in v2:
> * Mention stderr redirection
> * Use 4 spaces instead of tabs for code block to avoid overflowing
>   lines
>
>  doc/usage/netconsole.rst | 16 ++++++++--------
>  1 file changed, 8 insertions(+), 8 deletions(-)
>
> diff --git a/doc/usage/netconsole.rst b/doc/usage/netconsole.rst
> index 647f0c220b..f745615d9a 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.
> @@ -24,10 +24,10 @@ can be used for network console.
>
>  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
> +    => 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
>
> --
> 2.43.0
>

Reviewed-by: Tony Dinh <mibodhi@gmail.com>

All the best,
Tony
diff mbox series

Patch

diff --git a/doc/usage/netconsole.rst b/doc/usage/netconsole.rst
index 647f0c220b..f745615d9a 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.
@@ -24,10 +24,10 @@  can be used for network console.

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