summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTrevor Woerner <twoerner@gmail.com>2024-03-05 17:07:49 -0500
committerRichard Purdie <richard.purdie@linuxfoundation.org>2024-03-06 16:54:54 +0000
commit002a6bbf66924e2d485710a8caad96f127d01bc8 (patch)
tree89044bcec6fc8af26ae6bc2f1802737332c157f1
parentdbcb74ef818cb082e740f2d30482b2cfc2c54147 (diff)
downloadpoky-002a6bbf66924e2d485710a8caad96f127d01bc8.tar.gz
dev-manual: bmaptool: rename
What was previously known variously as Bmaptool, bmaptools, bmap-tool, and/or bmap-tools has been updated to the singular name: bmaptool. Update all references to suit. Since we are not in charge of debian's package naming policy, any references that relate to debian package(s) will stay as "bmap-tools". (From yocto-docs rev: 9c1505eabd69af548652381cf996d44f40a4fa8a) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/bmaptool.rst20
-rw-r--r--documentation/dev-manual/wic.rst2
2 files changed, 11 insertions, 11 deletions
diff --git a/documentation/dev-manual/bmaptool.rst b/documentation/dev-manual/bmaptool.rst
index 9add72cf3b..f6f0e6afaf 100644
--- a/documentation/dev-manual/bmaptool.rst
+++ b/documentation/dev-manual/bmaptool.rst
@@ -4,10 +4,10 @@ Flashing 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. 7bmaptool, which is integrated into the OpenEmbedded build system.
8Bmaptool is a generic tool that creates a file's block map (bmap) and 8bmaptool 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 bmap-tools-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,19 +39,19 @@ 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
46 - If you have write access to the media, use this command form:: 46 - If you have write access to the media, use this command form::
47 47
48 $ oe-run-native bmap-tools-native bmaptool copy build-directory/tmp/deploy/images/machine/image.wic /dev/sdX 48 $ oe-run-native bmaptool-native bmaptool copy build-directory/tmp/deploy/images/machine/image.wic /dev/sdX
49 49
50 - If you do not have write access to the media, set your permissions 50 - If you do not have write access to the media, set your permissions
51 first and then use the same command form:: 51 first and then use the same command form::
52 52
53 $ sudo chmod 666 /dev/sdX 53 $ sudo chmod 666 /dev/sdX
54 $ oe-run-native bmap-tools-native bmaptool copy build-directory/tmp/deploy/images/machine/image.wic /dev/sdX 54 $ oe-run-native bmaptool-native bmaptool copy build-directory/tmp/deploy/images/machine/image.wic /dev/sdX
55 55
56For help on the ``bmaptool`` command, use the following command:: 56For help on the ``bmaptool`` command, use the following command::
57 57
diff --git a/documentation/dev-manual/wic.rst b/documentation/dev-manual/wic.rst
index 312f78c403..05e9cb381b 100644
--- a/documentation/dev-manual/wic.rst
+++ b/documentation/dev-manual/wic.rst
@@ -503,7 +503,7 @@ Continuing with the example, you can now write the image from the
503built your image, and boot from the media. You can write the image by using 503built your image, and boot from the media. You can write the image by using
504``bmaptool`` or ``dd``:: 504``bmaptool`` or ``dd``::
505 505
506 $ oe-run-native bmap-tools-native bmaptool copy mkefidisk-201804191017-sda.direct /dev/sdX 506 $ oe-run-native bmaptool-native bmaptool copy mkefidisk-201804191017-sda.direct /dev/sdX
507 507
508or :: 508or ::
509 509