mail archive of the barebox mailing list
 help / color / mirror / Atom feed
* [PATCH] Documentation: networking: improve net.* variable description
@ 2023-02-06 13:45 Roland Hieber
  2023-02-08  8:23 ` Sascha Hauer
  0 siblings, 1 reply; 2+ messages in thread
From: Roland Hieber @ 2023-02-06 13:45 UTC (permalink / raw)
  To: barebox; +Cc: Roland Hieber

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
 Documentation/user/booting-linux.rst |  2 ++
 Documentation/user/networking.rst    | 10 ++++++----
 2 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/Documentation/user/booting-linux.rst b/Documentation/user/booting-linux.rst
index 60babb513cea..1a95f87e77c4 100644
--- a/Documentation/user/booting-linux.rst
+++ b/Documentation/user/booting-linux.rst
@@ -232,6 +232,8 @@ device where the entry is found on. This makes it possible to use the same rootf
 image on different devices without having to specify a different root= option each
 time.
 
+.. _booting_linux_net:
+
 Network boot
 ------------
 
diff --git a/Documentation/user/networking.rst b/Documentation/user/networking.rst
index 9231ebde56ac..2306cb6a60d1 100644
--- a/Documentation/user/networking.rst
+++ b/Documentation/user/networking.rst
@@ -45,15 +45,17 @@ device:
 |                              |              | any directly visible subnet. May be set        |
 |                              |              | automatically by DHCP.                         |
 +------------------------------+--------------+------------------------------------------------+
-| global.net.server            | hostname or  | The default server. If unspecified, may be set |
-|                              | ipv4 address | by DHCP                                        |
+| global.net.server            | hostname or  | The default server used by the defaultenv boot |
+|                              | ipv4 address | scripts for NFS and TFTP; see                  |
+|                              |              | :ref:`booting_linux_net`.                      |
+|                              |              | If unspecified, may be set by DHCP.            |
 +------------------------------+--------------+------------------------------------------------+
 | global.net.nameserver        | ipv4 address | The DNS server used for resolving host names.  |
-|                              |              | May be set by DHCP                             |
+|                              |              | May be set by DHCP.                            |
 +------------------------------+--------------+------------------------------------------------+
 | global.net.ifup_force_detect | boolean      | Set to true if your network device is not      |
 |                              |              | detected automatically during start (i.e. for  |
-|                              |              | USB network adapters)                          |
+|                              |              | USB network adapters).                         |
 +------------------------------+--------------+------------------------------------------------+
 
 The first step for networking is configuring the network device. The network
-- 
2.30.2




^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] Documentation: networking: improve net.* variable description
  2023-02-06 13:45 [PATCH] Documentation: networking: improve net.* variable description Roland Hieber
@ 2023-02-08  8:23 ` Sascha Hauer
  0 siblings, 0 replies; 2+ messages in thread
From: Sascha Hauer @ 2023-02-08  8:23 UTC (permalink / raw)
  To: Roland Hieber; +Cc: barebox

On Mon, Feb 06, 2023 at 02:45:51PM +0100, Roland Hieber wrote:
> Signed-off-by: Roland Hieber <rhi@pengutronix.de>
> ---
>  Documentation/user/booting-linux.rst |  2 ++
>  Documentation/user/networking.rst    | 10 ++++++----
>  2 files changed, 8 insertions(+), 4 deletions(-)

Applied, thanks

Sascha

> 
> diff --git a/Documentation/user/booting-linux.rst b/Documentation/user/booting-linux.rst
> index 60babb513cea..1a95f87e77c4 100644
> --- a/Documentation/user/booting-linux.rst
> +++ b/Documentation/user/booting-linux.rst
> @@ -232,6 +232,8 @@ device where the entry is found on. This makes it possible to use the same rootf
>  image on different devices without having to specify a different root= option each
>  time.
>  
> +.. _booting_linux_net:
> +
>  Network boot
>  ------------
>  
> diff --git a/Documentation/user/networking.rst b/Documentation/user/networking.rst
> index 9231ebde56ac..2306cb6a60d1 100644
> --- a/Documentation/user/networking.rst
> +++ b/Documentation/user/networking.rst
> @@ -45,15 +45,17 @@ device:
>  |                              |              | any directly visible subnet. May be set        |
>  |                              |              | automatically by DHCP.                         |
>  +------------------------------+--------------+------------------------------------------------+
> -| global.net.server            | hostname or  | The default server. If unspecified, may be set |
> -|                              | ipv4 address | by DHCP                                        |
> +| global.net.server            | hostname or  | The default server used by the defaultenv boot |
> +|                              | ipv4 address | scripts for NFS and TFTP; see                  |
> +|                              |              | :ref:`booting_linux_net`.                      |
> +|                              |              | If unspecified, may be set by DHCP.            |
>  +------------------------------+--------------+------------------------------------------------+
>  | global.net.nameserver        | ipv4 address | The DNS server used for resolving host names.  |
> -|                              |              | May be set by DHCP                             |
> +|                              |              | May be set by DHCP.                            |
>  +------------------------------+--------------+------------------------------------------------+
>  | global.net.ifup_force_detect | boolean      | Set to true if your network device is not      |
>  |                              |              | detected automatically during start (i.e. for  |
> -|                              |              | USB network adapters)                          |
> +|                              |              | USB network adapters).                         |
>  +------------------------------+--------------+------------------------------------------------+
>  
>  The first step for networking is configuring the network device. The network
> -- 
> 2.30.2
> 
> 
> 

-- 
Pengutronix e.K.                           |                             |
Steuerwalder Str. 21                       | http://www.pengutronix.de/  |
31137 Hildesheim, Germany                  | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |



^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2023-02-08  8:24 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-02-06 13:45 [PATCH] Documentation: networking: improve net.* variable description Roland Hieber
2023-02-08  8:23 ` Sascha Hauer

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox