From mboxrd@z Thu Jan 1 00:00:00 1970 Return-path: Received: from metis.ext.pengutronix.de ([2001:67c:670:201:290:27ff:fe1d:cc33]) by bombadil.infradead.org with esmtps (Exim 4.80.1 #2 (Red Hat Linux)) id 1aTRgo-0002W6-ET for barebox@lists.infradead.org; Wed, 10 Feb 2016 10:08:05 +0000 From: Robert Schwebel Date: Wed, 10 Feb 2016 11:07:37 +0100 Message-Id: <1455098857-25339-4-git-send-email-r.schwebel@pengutronix.de> In-Reply-To: <1455098857-25339-1-git-send-email-r.schwebel@pengutronix.de> References: <1455098857-25339-1-git-send-email-r.schwebel@pengutronix.de> List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "barebox" Errors-To: barebox-bounces+u.kleine-koenig=pengutronix.de@lists.infradead.org Subject: [PATCH 4/4] Documentation: networking: improve docs To: barebox@lists.infradead.org Add the following improvements: - clarify commands vs. filesystems for network file transport protocols - Beautify links with prosa text instead of standard headlines - adapt 'devinfo eth0' parameter output to current code - improve console texts - add docs for netconsole.active Signed-off-by: Robert Schwebel --- Documentation/user/networking.rst | 44 ++++++++++++++++++++++++--------------- 1 file changed, 27 insertions(+), 17 deletions(-) diff --git a/Documentation/user/networking.rst b/Documentation/user/networking.rst index 6eeb93d..c1b1857 100644 --- a/Documentation/user/networking.rst +++ b/Documentation/user/networking.rst @@ -1,26 +1,25 @@ Networking ========== -barebox has IPv4 networking support. Several protocols such as -:ref:`command_dhcp`, :ref:`filesystems_nfs`, :ref:`command_tftp` are -supported. +barebox has IPv4 networking support. Several protocols such as :ref:`DHCP +`, NFS and TFTP are supported. Network configuration --------------------- The first step for networking is configuring the network device. The network device is usually ``eth0``. The current configuration can be viewed with the -:ref:`command_devinfo` command: +:ref:`devinfo ` command: .. code-block:: sh barebox:/ devinfo eth0 Parameters: - ipaddr: 192.168.23.197 - serverip: 192.168.23.1 + ethaddr: 00:1c:49:01:03:4b gateway: 192.168.23.1 + ipaddr: 192.168.23.197 netmask: 255.255.0.0 - ethaddr: 00:1c:49:01:03:4b + serverip: 192.168.23.1 The configuration can be changed on the command line with: @@ -28,19 +27,21 @@ The configuration can be changed on the command line with: eth0.ipaddr=172.0.0.10 -The :ref:`command_dhcp` command will change the settings based on the answer +The :ref:`dhcp command ` will change the settings based on the answer from the DHCP server. This low-level configuration of the network interface is often not necessary. Normally the network settings should be edited in ``/env/network/eth0``, then the network interface -can be brought up using the :ref:`command_ifup` command. +can be brought up using the :ref:`ifup command `. Network filesystems ------------------- -barebox supports NFS and TFTP as filesystem implementations. See :ref:`filesystems_nfs` -and :ref:`filesystems_tftp` for more information. After the network device has been -brought up a network filesystem can be mounted with: +barebox supports NFS and TFTP both with commands (:ref:`nfs ` and +:ref:`tftp `) and as filesystem implementations; see +:ref:`filesystems_nfs` and :ref:`filesystems_tftp` for more information. After +the network device has been brought up, a network filesystem can be mounted +with: .. code-block:: sh @@ -52,8 +53,9 @@ or mount -t nfs 192.168.2.1:/export none /mnt -**NOTE:** this can often be hidden behind the :ref:`command_automount` command to make -mounting transparent to the user. +**NOTE:** The execution of the mount command can often be hidden behind the +:ref:`automount command `, to make mounting transparent to +the user. Network console --------------- @@ -71,11 +73,19 @@ risks. It can be enabled using: netconsole.ip=192.168.23.2 netconsole.active=ioe -This will send UDP packets to 192.168.23.2 on port 6666. On 192.168.23.2 the -scripts/netconsole script can be used to control barebox: +This will send UDP packets to a PC with IP address 192.168.23.2 and port 6666. + +The ``netconsole.active`` parameter consists of the fields "input" (i), +"output" (o) and "error" (e); if the fields are set, the respective channel is +activated on the network console. + +On the PC side, the ``scripts/netconsole`` script can be used to remote control +barebox: .. code-block:: sh scripts/netconsole 6666 -The netconsole can be used just like any other console. +The netconsole can be used just like any other console. Note, however, that the +simple console protocol is is UDP based, so there is no guarantee about packet +loss. -- 2.7.0.rc3 _______________________________________________ barebox mailing list barebox@lists.infradead.org http://lists.infradead.org/mailman/listinfo/barebox