summaryrefslogtreecommitdiffstats
path: root/Documentation/user
diff options
context:
space:
mode:
authorSascha Hauer <s.hauer@pengutronix.de>2016-03-11 10:49:43 +0100
committerSascha Hauer <s.hauer@pengutronix.de>2016-03-11 10:49:43 +0100
commitd69ea86d795aea0ad833f271f0690e5e02b8bbb6 (patch)
treeb7ce0a49e0bda76e3267db28c5f33cf1478aabe2 /Documentation/user
parent09c1f8244d4106cdb4d970a0a89928307230d8fb (diff)
parent1a0cebc5722675b72080958a90f163767876da92 (diff)
downloadbarebox-d69ea86d795aea0ad833f271f0690e5e02b8bbb6.tar.gz
barebox-d69ea86d795aea0ad833f271f0690e5e02b8bbb6.tar.xz
Merge branch 'for-next/doc'
Diffstat (limited to 'Documentation/user')
-rw-r--r--Documentation/user/barebox.rst10
-rw-r--r--Documentation/user/booting-linux.rst4
-rw-r--r--Documentation/user/networking.rst44
-rw-r--r--Documentation/user/user-manual.rst1
4 files changed, 36 insertions, 23 deletions
diff --git a/Documentation/user/barebox.rst b/Documentation/user/barebox.rst
index 00ceabb925..530693d743 100644
--- a/Documentation/user/barebox.rst
+++ b/Documentation/user/barebox.rst
@@ -113,9 +113,9 @@ with the most popular being ``menuconfig``::
make menuconfig
-barebox uses the same (Kbuild) configuration system as Linux, so you can use
-all the kernel config targets you already know, e.g. ``make xconfig``,
-``make allyesconfig`` etc.
+barebox uses the same configuration and build system as Linux (Kconfig,
+Kbuild), so you can use all the kernel config targets you already know, e.g.
+``make xconfig``, ``make allyesconfig`` etc.
Configuring and compiling "out-of-tree"
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -186,7 +186,9 @@ with U-Boot's 'go' command::
U-Boot: tftp $load_addr barebox.bin
U-Boot: go $load_addr
-With barebox already running on your board, this can be used to chainload another barebox::
+With barebox already running on your board, this can be used to chainload
+another barebox. For instance, if you mounted a TFTP server to ``/mnt/tftp``
+(see :ref:`filesystems_tftp` for how to do that), chainload barebox with::
bootm /mnt/tftp/barebox.bin
diff --git a/Documentation/user/booting-linux.rst b/Documentation/user/booting-linux.rst
index 5b021f0662..98628faf9d 100644
--- a/Documentation/user/booting-linux.rst
+++ b/Documentation/user/booting-linux.rst
@@ -6,7 +6,7 @@ Booting Linux
Introduction
------------
-The basic boot command in barebox is :ref:`command_bootm`. This command
+The lowlevel boot command in barebox is :ref:`command_bootm`. This command
can be used directly, but there is also a :ref:`command_boot` command
which offers additional features like a boot sequence which tries to
boot different entries until one succeeds.
@@ -14,7 +14,7 @@ boot different entries until one succeeds.
The bootm command
-----------------
-The :ref:`command_bootm` command is the basic boot command. Depending on the
+The :ref:`command_bootm` command is the lowlevel boot command. Depending on the
architecture the bootm command handles different image types. On ARM the
following images are supported:
diff --git a/Documentation/user/networking.rst b/Documentation/user/networking.rst
index 6eeb93dd88..8afb433837 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
+<command_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_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 <command_dhcp>` 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 <command_ifup>`.
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 <command_nfs>` and
+:ref:`tftp <command_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 <command_automount>`, 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 <board IP> 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 UDP based, so there is no guarantee about packet
+loss.
diff --git a/Documentation/user/user-manual.rst b/Documentation/user/user-manual.rst
index 0d6daee70e..be44f0d645 100644
--- a/Documentation/user/user-manual.rst
+++ b/Documentation/user/user-manual.rst
@@ -27,6 +27,7 @@ Contents:
usb
ubi
booting-linux
+ remote-control
system-setup
reset-reason
system-reset