diff options
| author | Michael Opdenacker <michael.opdenacker@rootcommit.com> | 2024-12-18 14:47:00 +0000 |
|---|---|---|
| committer | Steve Sakoman <steve@sakoman.com> | 2024-12-23 05:46:32 -0800 |
| commit | 37f15b8e70bb9177a60a9286b21aeba230296a9d (patch) | |
| tree | e1d6ed7ac292015943c3feb667b5b6214bbceb8a /documentation/dev-manual | |
| parent | a789e8622a173ba6170127744afccb21355c4142 (diff) | |
| download | poky-37f15b8e70bb9177a60a9286b21aeba230296a9d.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: 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>
Diffstat (limited to 'documentation/dev-manual')
| -rw-r--r-- | documentation/dev-manual/bmaptool.rst | 18 | ||||
| -rw-r--r-- | documentation/dev-manual/wic.rst | 4 |
2 files changed, 11 insertions, 11 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 | ||
| 3 | Flashing Images Using ``bmaptool`` | 3 | Flashing Images Using `bmaptool` |
| 4 | ********************************** | 4 | ******************************** |
| 5 | 5 | ||
| 6 | A fast and easy way to flash an image to a bootable device is to use | 6 | A fast and easy way to flash an image to a bootable device is to use |
| 7 | bmaptool, which is integrated into the OpenEmbedded build system. | 7 | `bmaptool`, which is integrated into the OpenEmbedded build system. |
| 8 | bmaptool 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 |
| 9 | then uses that map to copy the file. As compared to traditional tools | 9 | then uses that map to copy the file. As compared to traditional tools |
| 10 | such as dd or cp, bmaptool can copy (or flash) large files like raw | 10 | such as `dd` or `cp`, `bmaptool` can copy (or flash) large files like raw |
| 11 | system image files much faster. | 11 | system 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 | ||
| 27 | Following, is an example that shows how to flash a Wic image. Realize | 27 | Following, is an example that shows how to flash a Wic image. Realize |
| 28 | that while this example uses a Wic image, you can use bmaptool to flash | 28 | that while this example uses a Wic image, you can use `bmaptool` to flash |
| 29 | any type of image. Use these steps to flash an image using bmaptool: | 29 | any 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 | ||
diff --git a/documentation/dev-manual/wic.rst b/documentation/dev-manual/wic.rst index a3880f3a1c..fced0e170c 100644 --- a/documentation/dev-manual/wic.rst +++ b/documentation/dev-manual/wic.rst | |||
| @@ -513,7 +513,7 @@ or :: | |||
| 513 | 513 | ||
| 514 | For more information on how to use the ``bmaptool`` | 514 | For more information on how to use the ``bmaptool`` |
| 515 | to flash a device with an image, see the | 515 | to flash a device with an image, see the |
| 516 | ":ref:`dev-manual/bmaptool:flashing images using \`\`bmaptool\`\``" | 516 | ":ref:`dev-manual/bmaptool:flashing images using \`bmaptool\``" |
| 517 | section. | 517 | section. |
| 518 | 518 | ||
| 519 | Using a Modified Kickstart File | 519 | Using a Modified Kickstart File |
| @@ -721,7 +721,7 @@ the existing kernel, and then inserts a new kernel: | |||
| 721 | 721 | ||
| 722 | Once the new kernel is added back into the image, you can use the | 722 | Once the new kernel is added back into the image, you can use the |
| 723 | ``dd`` command or :ref:`bmaptool | 723 | ``dd`` command or :ref:`bmaptool |
| 724 | <dev-manual/bmaptool:flashing images using \`\`bmaptool\`\`>` | 724 | <dev-manual/bmaptool:flashing images using \`bmaptool\`>` commands |
| 725 | to flash your wic image onto an SD card or USB stick and test your | 725 | to flash your wic image onto an SD card or USB stick and test your |
| 726 | target. | 726 | target. |
| 727 | 727 | ||
