MIRRORS/poky
1
0
Fork 0
mirror of git://git.yoctoproject.org/poky.git synced 2025-07-19 12:59:02 +02:00
Code Issues Actions 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: c569d840c4b6f43e10629b6f1ff45189211e27a9)

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>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Michael Opdenacker 2024-12-18 14:47:00 +00:00 committed by Richard Purdie
parent c9565b89d0
commit 6e09a26641
2 changed files with 11 additions and 11 deletions
Show Stats 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
Flashing Images Using ``bmaptool``
**********************************
Flashing Images Using `bmaptool`
********************************
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 is a generic tool that creates a file's block map (bmap) and
`bmaptool`, which is integrated into the OpenEmbedded build system.
`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
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.
.. note::
@ -20,13 +20,13 @@ system image files much faster.
$ sudo apt install bmap-tools
- 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
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
any type of image. Use these steps to flash an image using bmaptool:
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`:
#. *Update your local.conf File:* You need to have the following set
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
#. *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
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``
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.
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
``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
target.