mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-01-29 21:08:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

dev-manual: fix styling of references to bmaptool

Browse Source 
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: 55146fae45e8c2de1d0f7242f1c89f3e165d77c9)

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>
This commit is contained in:
Michael Opdenacker
2024-12-18 14:47:00 +00:00
committed by Steve Sakoman
parent a789e8622a
commit 37f15b8e70
2 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
documentation/dev-manual/bmaptool.rst
View File

@@ -1,13 +1,13 @@
.. SPDX-License-Identifier: CC-BY-SA-2.0-UK .. SPDX-License-Identifier: CC-BY-SA-2.0-UK
Flashing Images Using ``bmaptool`` Flashing Images Using `bmaptool`
********************************** ********************************
A fast and easy way to flash an image to a bootable device is to use A fast and easy way to flash an image to a bootable device is to use
bmaptool, which is integrated into the OpenEmbedded build system. `bmaptool`, which is integrated into the OpenEmbedded build system.
bmaptool is a generic tool that creates a file's block map (bmap) and `bmaptool` is a generic tool that creates a file's block map (bmap) and
then uses that map to copy the file. As compared to traditional tools then uses that map to copy the file. As compared to traditional tools
such as dd or cp, bmaptool can copy (or flash) large files like raw such as `dd` or `cp`, `bmaptool` can copy (or flash) large files like raw
system image files much faster. system image files much faster.
.. note:: .. note::
@@ -20,13 +20,13 @@ system image files much faster.
$ sudo apt install bmap-tools $ sudo apt install bmap-tools
- If you are unable to install the ``bmap-tools`` package, you will - If you are unable to install the ``bmap-tools`` package, you will
need to build bmaptool before using it. Use the following command:: need to build `bmaptool` before using it. Use the following command::
$ bitbake bmaptool-native $ bitbake bmaptool-native
Following, is an example that shows how to flash a Wic image. Realize Following, is an example that shows how to flash a Wic image. Realize
that while this example uses a Wic image, you can use bmaptool to flash that while this example uses a Wic image, you can use `bmaptool` to flash
any type of image. Use these steps to flash an image using bmaptool: any type of image. Use these steps to flash an image using `bmaptool`:
#. *Update your local.conf File:* You need to have the following set #. *Update your local.conf File:* You need to have the following set
in your ``local.conf`` file before building your image:: 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:
$ bitbake image $ bitbake image
#. *Flash the Device:* Flash the device with the image by using bmaptool #. *Flash the Device:* Flash the device with the image by using `bmaptool`
depending on your particular setup. The following commands assume the depending on your particular setup. The following commands assume the
image resides in the :term:`Build Directory`'s ``deploy/images/`` area: image resides in the :term:`Build Directory`'s ``deploy/images/`` area:

4
documentation/dev-manual/wic.rst
View File

@@ -513,7 +513,7 @@ or ::
For more information on how to use the ``bmaptool`` For more information on how to use the ``bmaptool``
to flash a device with an image, see the to flash a device with an image, see the
":ref:`dev-manual/bmaptool:flashing images using \`\`bmaptool\`\``" ":ref:`dev-manual/bmaptool:flashing images using \`bmaptool\``"
section. section.
Using a Modified Kickstart File Using a Modified Kickstart File
@@ -721,7 +721,7 @@ the existing kernel, and then inserts a new kernel:
Once the new kernel is added back into the image, you can use the Once the new kernel is added back into the image, you can use the
``dd`` command or :ref:`bmaptool ``dd`` command or :ref:`bmaptool
<dev-manual/bmaptool:flashing images using \`\`bmaptool\`\`>` <dev-manual/bmaptool:flashing images using \`bmaptool\`>` commands
to flash your wic image onto an SD card or USB stick and test your to flash your wic image onto an SD card or USB stick and test your
target. target.