doc: add colon after NOTE and HINT
Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
This commit is contained in:
parent
ce9d79cc4f
commit
d4efb42f80
|
@ -33,6 +33,6 @@ Build the binary image::
|
|||
|
||||
make ARCH=arm CROSS_COMPILE=armv5compiler
|
||||
|
||||
**NOTE** Replace ''armv5compiler'' with your ARM v5 cross compiler, e.g.: ''arm-1136jfs-linux-gnueabi-''
|
||||
**NOTE:** replace ''armv5compiler'' with your ARM v5 cross compiler, e.g.: ''arm-1136jfs-linux-gnueabi-''
|
||||
|
||||
The resulting binary image to be flashed will be barebox.bin, whereas the file named just barebox is an ELF executable for ARM.
|
||||
|
|
|
@ -26,7 +26,7 @@ Build the bootloader binary image::
|
|||
|
||||
make ARCH=arm CROSS_COMPILE=armv5compiler
|
||||
|
||||
NOTE replace the armv5compiler with your ARM v5 cross compiler.
|
||||
**NOTE:** replace the armv5compiler with your ARM v5 cross compiler.
|
||||
|
||||
How to prepare an MCI card to boot the "chumby one" with barebox
|
||||
----------------------------------------------------------------
|
||||
|
|
|
@ -25,4 +25,4 @@ Build the bootloader binary image::
|
|||
|
||||
make ARCH=arm CROSS_COMPILE=armv5compiler
|
||||
|
||||
**NOTE** replace the armv5compiler with your ARM v5 cross compiler.
|
||||
**NOTE:** replace the armv5compiler with your ARM v5 cross compiler.
|
||||
|
|
|
@ -31,9 +31,9 @@ Build the binary image::
|
|||
|
||||
make ARCH=arm CROSS_COMPILE=armv5compiler
|
||||
|
||||
**NOTE** replace the armv5compiler with your ARM v5 cross compiler.
|
||||
**NOTE:** replace the armv5compiler with your ARM v5 cross compiler.
|
||||
|
||||
**NOTE** To use the result, you also need the following resources from Freescale:
|
||||
**NOTE:** to use the result, you also need the following resources from Freescale:
|
||||
* the 'bootlets' archive
|
||||
* the 'elftosb2' encryption tool
|
||||
* in the case you want to start @b barebox from an attached SD card the 'sdimage' tool from Freescale's 'uuc' archive.
|
||||
|
|
|
@ -64,4 +64,4 @@ Build the binary image::
|
|||
|
||||
make ARCH=arm CROSS_COMPILE=armv4compiler
|
||||
|
||||
**NOTE** replace the armv4compiler with your ARM v4 cross compiler.
|
||||
**NOTE:** replace the armv4compiler with your ARM v4 cross compiler.
|
||||
|
|
|
@ -14,7 +14,7 @@ multi-image build (:ref:`multi_image`). Building is as easy as typing:
|
|||
make ARCH=arm tegra_v7_defconfig
|
||||
make ARCH=arm CROSS_COMPILE=arm-v7-compiler-
|
||||
|
||||
**NOTE** replace the arm-v7-compiler- with your ARM v7 cross compiler.
|
||||
**NOTE:** replace the arm-v7-compiler- with your ARM v7 cross compiler.
|
||||
|
||||
Tegra images are specific to the bootsource. The build will generate images for
|
||||
all combinations of bootsources and supported boards. You can find the
|
||||
|
@ -69,7 +69,7 @@ You should now see barebox coming up on the serial console.
|
|||
Writing barebox to the primary boot device
|
||||
------------------------------------------
|
||||
|
||||
**NOTE** This may change in the near future to work with the standard
|
||||
**NOTE:** this may change in the near future to work with the standard
|
||||
barebox update mechanism (:ref:`update`).
|
||||
|
||||
Copy the image corresponding to the primary boot device for your board to a
|
||||
|
|
|
@ -122,7 +122,7 @@ not exist::
|
|||
MBR barebox first
|
||||
main image partition
|
||||
|
||||
**NOTE** The setupmbr tool is also working on real image file than on device
|
||||
nodes only. So, there is no restriction what kind of file will be
|
||||
modified.
|
||||
**NOTE:** the ``setupmbr`` tool is also working on real image file than on device
|
||||
nodes only. So, there is no restriction what kind of file will be
|
||||
modified.
|
||||
|
||||
|
|
|
@ -48,7 +48,7 @@ variable:
|
|||
global.bootm.image=/path/to/zImage
|
||||
bootm
|
||||
|
||||
**NOTE** It may happen that barebox is probed from the devicetree, but you have
|
||||
**NOTE:** it may happen that barebox is probed from the devicetree, but you have
|
||||
want to start a Kernel without passing a devicetree. In this case call ``oftree -f``
|
||||
to free the internal devicetree before calling ``bootm``
|
||||
|
||||
|
|
|
@ -87,5 +87,5 @@ device variables may have a type, so assigning wrong values may fail::
|
|||
barebox@Genesi Efika MX Smartbook:/ echo $?
|
||||
1
|
||||
|
||||
**HINT** barebox has tab completion for variables. Typing ``eth0.<TAB><TAB>``
|
||||
**HINT:** barebox has tab completion for variables. Typing ``eth0.<TAB><TAB>``
|
||||
will show the parameters for eth0.
|
||||
|
|
|
@ -52,7 +52,7 @@ 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
|
||||
**NOTE:** this can often be hidden behind the :ref:`command_automount` command to make
|
||||
mounting transparent to the user.
|
||||
|
||||
Network console
|
||||
|
|
|
@ -26,6 +26,6 @@ This way source code can be shared between regular barebox and PBL. A special
|
|||
case is ``lwl-y += file.o`` which expands to ``obj-y`` when PBL is disabled
|
||||
and to ``pbl-y`` when PBL is enabled.
|
||||
|
||||
**HINT** For getting an overview over the binaries, disassemble barebox.bin
|
||||
**HINT:** for getting an overview over the binaries, disassemble barebox.bin
|
||||
(``make barebox.S``) with or without PBL support and also disassemble the
|
||||
PBL (``make arch/$ARCH/pbl/zbarebox.S``)
|
||||
|
|
|
@ -19,7 +19,7 @@ If you intend to use a device with UBI you should always use ``ubiformat`` inste
|
|||
:ref:`command_erase`. ``ubiformat`` will make sure the erasecounters are preserved and also
|
||||
:ref:`ubi_fastmap` won't work when a flash is erased with ``erase``
|
||||
|
||||
NOTE: When using the :ref:`ubi_fastmap` feature make sure that the UBI is attached and detached
|
||||
**NOTE:** when using the :ref:`ubi_fastmap` feature make sure that the UBI is attached and detached
|
||||
once after using ``ubiformat``. This makes sure the Fastmap is written.
|
||||
|
||||
After a device has been formatted it can be attached with :ref:`command_ubiattach`.
|
||||
|
|
|
@ -18,7 +18,7 @@ other variable. You can also directly assign a value during creation::
|
|||
|
||||
global myvar1=foobar
|
||||
|
||||
**NOTE** creating a variable with ``global myvar1=foobar`` looks very similar
|
||||
**NOTE:** creating a variable with ``global myvar1=foobar`` looks very similar
|
||||
to assigning a value with ``global.myvar1=foobar``, but the latter fails when
|
||||
a variable has not been created before.
|
||||
|
||||
|
|
Loading…
Reference in New Issue