Explorar o código

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: 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>
Michael Opdenacker hai 5 meses
pai
achega
6e09a26641
Modificáronse 2 ficheiros con 11 adicións e 11 borrados
  1. 9 9
      documentation/dev-manual/bmaptool.rst
  2. 2 2
      documentation/dev-manual/wic.rst

+ 9 - 9
documentation/dev-manual/bmaptool.rst

@@ -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 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
 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
-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
 #. *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:
 
 

+ 2 - 2
documentation/dev-manual/wic.rst

@@ -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.