9
0
Fork 0

Documentation: Numerous typoes/fixes in first few chapters of user manual.

Doc fixes such as:

 * font changes
 * spelling
 * punctuation
 * capitalization

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
This commit is contained in:
Robert P. J. Day 2014-07-02 14:57:01 -04:00 committed by Sascha Hauer
parent 009e5365d0
commit aac1b35c88
7 changed files with 24 additions and 22 deletions

View File

@ -15,18 +15,18 @@ TFTP server, the following is required::
mkdir -p /mnt/tftp mkdir -p /mnt/tftp
automount /mnt/tftp 'ifup eth0 && mount -t tftp $eth0.serverip /mnt/tftp' automount /mnt/tftp 'ifup eth0 && mount -t tftp $eth0.serverip /mnt/tftp'
This creates an automountpoint on /mnt/tftp. Whenever this directory is accessed, This creates an automountpoint on ``/mnt/tftp``. Whenever this directory is accessed,
the command ``ifup eth0 && mount -t tftp $eth0.serverip /mnt/tftp`` is executed. the command ``ifup eth0 && mount -t tftp $eth0.serverip /mnt/tftp`` is executed.
It will bring up the network device using :ref:`command_ifup` and mount a TFTP filesystem It will bring up the network device using :ref:`command_ifup` and mount a TFTP filesystem
using :ref:`command_mount`. using :ref:`command_mount`.
Usually the above automount command is executed from an init script in /env/init/automount. Usually the above automount command is executed from an init script in ``/env/init/automount``.
With the above, files on the TFTP server can be accessed without configuration:: With the above, files on the TFTP server can be accessed without configuration::
cp /mnt/tftp/linuximage /image cp /mnt/tftp/linuximage /image
This automatically detects a USB mass storage device and mounts the first This automatically detects a USB mass storage device and mounts the first
partition to /mnt/fat:: partition to ``/mnt/fat``::
mkdir -p /mnt/fat mkdir -p /mnt/fat
automount -d /mnt/fat 'usb && [ -e /dev/disk0.0 ] && mount /dev/disk0.0 /mnt/fat' automount -d /mnt/fat 'usb && [ -e /dev/disk0.0 ] && mount /dev/disk0.0 /mnt/fat'

View File

@ -44,7 +44,7 @@ barebox uses Kconfig from the Linux kernel as a configuration tool,
where all configuration is done via the ``make`` command. Before running where all configuration is done via the ``make`` command. Before running
it you have to specify your architecture with the ``ARCH`` environment it you have to specify your architecture with the ``ARCH`` environment
variable and the cross compiler with the ``CROSS_COMPILE`` environment variable and the cross compiler with the ``CROSS_COMPILE`` environment
variable. ``ARCH`` has to be one of: variable. Currently, ``ARCH`` must be one of:
* arm * arm
* blackfin * blackfin

View File

@ -2,8 +2,8 @@ Driver model
============ ============
barebox has a driver model. This matches the devices on a board with their barebox has a driver model. This matches the devices on a board with their
corresponding drivers. From a users point of view this is mostly visible in the corresponding drivers. From a user's point of view this is mostly visible in the
:ref:`command_devinfo` and :ref:`command_drvinfo` command. Without arguments :ref:`command_devinfo` and :ref:`command_drvinfo` commands. Without arguments
the :ref:`command_devinfo` command will show a hierarchical list of devices the :ref:`command_devinfo` command will show a hierarchical list of devices
found on the board. As this may be instantiated from the :ref:`devicetree` found on the board. As this may be instantiated from the :ref:`devicetree`
there may be devices listed for which no driver is available. The there may be devices listed for which no driver is available. The

View File

@ -1,23 +1,25 @@
Introduction Introduction
============ ============
This is the barebox user manual. It describes how to configure, compile This is the barebox user manual, which describes how to configure, compile
and run barebox on Embedded Systems. and run barebox on embedded systems.
barebox (just barebox, not *the* barebox) is a bootloader designed for barebox (just barebox, not *the* barebox) is a bootloader designed for
Embedded Systems. It runs on a variety of ARM, MIPS, PowerPC based SoCs. embedded systems. It runs on a variety of architectures including
x86, ARM, MIPS, PowerPC and others.
barebox aims to be a versatile and flexible bootloader, not only for barebox aims to be a versatile and flexible bootloader, not only for
booting Embedded Linux Systems but also for initial hardware bringup and booting embedded Linux systems, but also for initial hardware bringup and
development. barebox is highly configurable to be suitable as a full featured development. barebox is highly configurable to be suitable as a full-featured
development binary to a lean production system. Just like busybox is the swiss development binary as well as for lean production systems.
army knife for Embedded Linux, barebox is the swiss army knife for bare metal, Just like busybox is the Swiss Army Knife for embedded Linux,
hence the name. barebox is the Swiss Army Knife for bare metal, hence the name.
Feedback Feedback
-------- --------
For sending patches, asking for help and giving general feedback you are For sending patches, asking for help and giving general feedback you are
always welcome to write a mail to the barebox mailing list. Most of the always welcome to write an e-mail to the barebox mailing list. Most of the
discussion of barebox takes place here: discussion of barebox takes place here:
http://lists.infradead.org/mailman/listinfo/barebox/ http://lists.infradead.org/mailman/listinfo/barebox/

View File

@ -1,8 +1,8 @@
Memory areas Memory areas
============ ============
Several barebox commands like :ref:`command_md`, erase or crc work on an area Several barebox commands like :ref:`command_md`, :ref:`command_erase`
of memory. Areas have the following form:: or :ref:`command_crc` work on an area of memory. Areas have the following form::
<start>-<end> <start>-<end>

View File

@ -31,7 +31,7 @@ The configuration can be changed on the command line with:
The :ref:`command_dhcp` command will change the settings based on the answer The :ref:`command_dhcp` command will change the settings based on the answer
from the DHCP server. from the DHCP server.
This low level configuration of the network interface is often not necessary. Normally 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 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:`command_ifup` command.
@ -58,8 +58,8 @@ mounting transparent to the user.
Network console Network console
--------------- ---------------
barebox has a udp based network console. If enabled in the config, you will see barebox has a UDP-based network console. If enabled in the config, you will see
something like this during startup: something like this during startup::
registered netconsole as cs1 registered netconsole as cs1
@ -71,7 +71,7 @@ risks. It can be enabled using:
cs1.ip=192.168.23.2 cs1.ip=192.168.23.2
cs1.active=ioe cs1.active=ioe
This will send udp packets to 192.168.23.2 on port 6666. On 192.168.23.2 the 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: scripts/netconsole script can be used to control barebox:
.. code-block:: sh .. code-block:: sh

View File

@ -31,7 +31,7 @@ Magic variables
--------------- ---------------
Some variables have special meanings and influence the behaviour Some variables have special meanings and influence the behaviour
of barebox. Most but not all of them are consolidated in the :ref:`global_device` of barebox. Most but not all of them are consolidated in the :ref:`global_device`.
Since it's hard to remember which variables these are and if the current Since it's hard to remember which variables these are and if the current
barebox has support for them the :ref:`command_magicvar` command can print a list barebox has support for them the :ref:`command_magicvar` command can print a list
of all variables with special meaning along with a short description:: of all variables with special meaning along with a short description::