summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/bmaptool.rst
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@rootcommit.com>2024-12-18 14:47:00 +0000
committerSteve Sakoman <steve@sakoman.com>2024-12-26 06:01:37 -0800
commite1c2e2e3faf68d68db1b3de40c3ed465eb7f867f (patch)
tree825df3e950d676ea0de735b872562395021aad59 /documentation/dev-manual/bmaptool.rst
parente82dc2ad3c04a1499c0ea68295a94920151958f3 (diff)
downloadpoky-e1c2e2e3faf68d68db1b3de40c3ed465eb7f867f.tar.gz
dev-manual: fix styling of references to bmaptool
To follow the styling conventions when we are refering to the name of a tool instead of the command itself (documentation/standards.md). This also improves the HTML rendering of the bmaptools subsection. (From yocto-docs rev: f8bf503b13a53fb0b34c1fdac92d78d66813abfb) Signed-off-by: Michael Opdenacker <michael.opdenacker@rootcommit.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit c569d840c4b6f43e10629b6f1ff45189211e27a9) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
Diffstat (limited to 'documentation/dev-manual/bmaptool.rst')
-rw-r--r--documentation/dev-manual/bmaptool.rst18
1 files changed, 9 insertions, 9 deletions
diff --git a/documentation/dev-manual/bmaptool.rst b/documentation/dev-manual/bmaptool.rst
index f6f0e6afaf..493abf7607 100644
--- a/documentation/dev-manual/bmaptool.rst
+++ b/documentation/dev-manual/bmaptool.rst
@@ -1,13 +1,13 @@
1.. SPDX-License-Identifier: CC-BY-SA-2.0-UK 1.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
2 2
3Flashing Images Using ``bmaptool`` 3Flashing Images Using `bmaptool`
4********************************** 4********************************
5 5
6A fast and easy way to flash an image to a bootable device is to use 6A fast and easy way to flash an image to a bootable device is to use
7bmaptool, which is integrated into the OpenEmbedded build system. 7`bmaptool`, which is integrated into the OpenEmbedded build system.
8bmaptool is a generic tool that creates a file's block map (bmap) and 8`bmaptool` is a generic tool that creates a file's block map (bmap) and
9then uses that map to copy the file. As compared to traditional tools 9then uses that map to copy the file. As compared to traditional tools
10such as dd or cp, bmaptool can copy (or flash) large files like raw 10such as `dd` or `cp`, `bmaptool` can copy (or flash) large files like raw
11system image files much faster. 11system image files much faster.
12 12
13.. note:: 13.. note::
@@ -20,13 +20,13 @@ system image files much faster.
20 $ sudo apt install bmap-tools 20 $ sudo apt install bmap-tools
21 21
22 - If you are unable to install the ``bmap-tools`` package, you will 22 - If you are unable to install the ``bmap-tools`` package, you will
23 need to build bmaptool before using it. Use the following command:: 23 need to build `bmaptool` before using it. Use the following command::
24 24
25 $ bitbake bmaptool-native 25 $ bitbake bmaptool-native
26 26
27Following, is an example that shows how to flash a Wic image. Realize 27Following, is an example that shows how to flash a Wic image. Realize
28that while this example uses a Wic image, you can use bmaptool to flash 28that while this example uses a Wic image, you can use `bmaptool` to flash
29any type of image. Use these steps to flash an image using bmaptool: 29any type of image. Use these steps to flash an image using `bmaptool`:
30 30
31#. *Update your local.conf File:* You need to have the following set 31#. *Update your local.conf File:* You need to have the following set
32 in your ``local.conf`` file before building your image:: 32 in your ``local.conf`` file before building your image::
@@ -39,7 +39,7 @@ any type of image. Use these steps to flash an image using bmaptool:
39 39
40 $ bitbake image 40 $ bitbake image
41 41
42#. *Flash the Device:* Flash the device with the image by using bmaptool 42#. *Flash the Device:* Flash the device with the image by using `bmaptool`
43 depending on your particular setup. The following commands assume the 43 depending on your particular setup. The following commands assume the
44 image resides in the :term:`Build Directory`'s ``deploy/images/`` area: 44 image resides in the :term:`Build Directory`'s ``deploy/images/`` area:
45 45