From d552379be3b0240866d1a7d6fe206c0d93aeb43b Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <srifenbark@gmail.com>
Date: Wed, 28 Jun 2017 10:16:07 -0700
Subject: dev-manual: Moved the "Flashing Images using bmaptool" section.

Fixes [YOCTO #11630]

Moved this section from the "Getting Started with the Yocto
Project" section.  The topic is not really a getting started
topic.  It is better suited in the "Common Tasks" chapter.

(From yocto-docs rev: d6cdade9066bdbce0596672978c178d2ec82c9a4)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 .../dev-manual/dev-manual-common-tasks.xml         | 92 ++++++++++++++++++++++
 1 file changed, 92 insertions(+)

(limited to 'documentation/dev-manual/dev-manual-common-tasks.xml')

diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 71d765089e..0879d0d3e0 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -5887,6 +5887,98 @@
         </para>
     </section>
 
+    <section id='flashing-images-using-bmaptool'>
+        <title>Flashing Images Using <filename>bmaptool</filename></title>
+
+        <para>
+            An easy way to flash an image to a bootable device is to use
+            <filename>bmaptool</filename>, which is integrated into the
+            OpenEmbedded build system.
+        </para>
+
+        <para>
+            Following, is an example that shows how to flash a Wic image.
+            <note>
+                You can use <filename>bmaptool</filename> to flash any
+                type of image.
+            </note>
+            Use these steps to flash an image using
+            <filename>bmaptool</filename>:
+            <note>
+                Unless you are able to install the
+                <filename>bmap-tools</filename> package as mentioned in the note
+                in the second bullet of step 3 further down, you will need to build
+                <filename>bmaptool</filename> before using it.
+                Build the tool using the following command:
+                <literallayout class='monospaced'>
+     $ bitbake bmap-tools-native
+                </literallayout>
+            </note>
+            <orderedlist>
+                <listitem><para>
+                    <emphasis>Update the <filename>local.conf</filename> File:</emphasis>
+                    Add the following to your <filename>local.conf</filename>
+                    file:
+                    <literallayout class='monospaced'>
+     IMAGE_FSTYPES += "wic wic.bmap"
+                    </literallayout>
+                    </para></listitem>
+                <listitem><para>
+                    <emphasis>Get Your Image:</emphasis>
+                    Either have your image ready (pre-built) or take the step
+                    build the image:
+                    <literallayout class='monospaced'>
+     $ bitbake <replaceable>image</replaceable>
+                    </literallayout>
+                    </para></listitem>
+                <listitem><para>
+                    <emphasis>Flash the Device:</emphasis>
+                    Flash the device with the image by using
+                    <filename>bmaptool</filename> depending on your particular
+                    setup:
+                    <itemizedlist>
+                        <listitem><para>
+                            If you have write access to the media,
+                            use this command form:
+                            <literallayout class='monospaced'>
+     $ oe-run-native bmaptool-native bmaptool copy ./tmp/deploy/images/qemux86-64-core-image-minimal-<replaceable>machine</replaceable>.wic /dev/sd<replaceable>X</replaceable>
+                            </literallayout>
+                            </para></listitem>
+                        <listitem><para>
+                            If you do not have write access to
+                            the media, use the following
+                            commands:
+                            <literallayout class='monospaced'>
+     $ sudo bash
+     $ PATH=tmp/sysroots/x86_64-linux/usr/bin/ bmaptool copy ./tmp/deploy/images/qemux86-64/core-image-minimal-<replaceable>machine</replaceable>.wic /dev/sd<replaceable>X</replaceable>
+                            </literallayout>
+                            <note>
+                                If you are using Ubuntu or Debian distributions,
+                                you can install the
+                                <filename>bmap-tools</filename> package using
+                                the following command and then use the tool
+                                without specifying
+                                <filename>PATH</filename> even from the
+                                root account:
+                                <literallayout class='monospaced'>
+     $ sudo apt-get install bmap-tools
+                                </literallayout>
+                            </note>
+                            </para></listitem>
+                    </itemizedlist>
+                    </para></listitem>
+            </orderedlist>
+        </para>
+
+        <para>
+            For help on the <filename>bmaptool</filename> command, use the
+            following command:
+            <literallayout class='monospaced'>
+     $ bmaptool --help
+            </literallayout>
+        </para>
+    </section>
+
     <section id='configuring-the-kernel'>
         <title>Configuring the Kernel</title>
 
-- 
cgit v1.2.3-54-g00ecf