From d4efb42f80253c979e32459bc755318d696de654 Mon Sep 17 00:00:00 2001 From: Holger Schurig Date: Fri, 27 Jun 2014 13:00:16 +0200 Subject: doc: add colon after NOTE and HINT Signed-off-by: Holger Schurig Signed-off-by: Sascha Hauer --- Documentation/user/booting-linux.rst | 2 +- Documentation/user/driver-model.rst | 2 +- Documentation/user/networking.rst | 2 +- Documentation/user/pbl.rst | 2 +- Documentation/user/ubi.rst | 2 +- Documentation/user/variables.rst | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) (limited to 'Documentation/user') diff --git a/Documentation/user/booting-linux.rst b/Documentation/user/booting-linux.rst index 4ae9d1b523..17427f3636 100644 --- a/Documentation/user/booting-linux.rst +++ b/Documentation/user/booting-linux.rst @@ -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`` diff --git a/Documentation/user/driver-model.rst b/Documentation/user/driver-model.rst index 2ec55f1385..fae275e00c 100644 --- a/Documentation/user/driver-model.rst +++ b/Documentation/user/driver-model.rst @@ -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.`` +**HINT:** barebox has tab completion for variables. Typing ``eth0.`` will show the parameters for eth0. diff --git a/Documentation/user/networking.rst b/Documentation/user/networking.rst index 9c7bde44fc..c22685f9ba 100644 --- a/Documentation/user/networking.rst +++ b/Documentation/user/networking.rst @@ -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 diff --git a/Documentation/user/pbl.rst b/Documentation/user/pbl.rst index a08d6c9d77..6757768e42 100644 --- a/Documentation/user/pbl.rst +++ b/Documentation/user/pbl.rst @@ -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``) diff --git a/Documentation/user/ubi.rst b/Documentation/user/ubi.rst index a2e386fdc9..a187680e2c 100644 --- a/Documentation/user/ubi.rst +++ b/Documentation/user/ubi.rst @@ -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`. diff --git a/Documentation/user/variables.rst b/Documentation/user/variables.rst index 04e179114e..e349874419 100644 --- a/Documentation/user/variables.rst +++ b/Documentation/user/variables.rst @@ -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. -- cgit v1.2.3