summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-common-tasks.xml
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-06-28 10:16:07 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-07-12 00:28:14 +0100
commitd552379be3b0240866d1a7d6fe206c0d93aeb43b (patch)
treea874e83a0df4ccf3d44252621322ca3f1676a58f /documentation/dev-manual/dev-manual-common-tasks.xml
parent15a41d25e961b4e4becc549cbbb25573c51cadfa (diff)
downloadpoky-d552379be3b0240866d1a7d6fe206c0d93aeb43b.tar.gz
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>
Diffstat (limited to 'documentation/dev-manual/dev-manual-common-tasks.xml')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml92
1 files changed, 92 insertions, 0 deletions
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 @@
5887 </para> 5887 </para>
5888 </section> 5888 </section>
5889 5889
5890 <section id='flashing-images-using-bmaptool'>
5891 <title>Flashing Images Using <filename>bmaptool</filename></title>
5892
5893 <para>
5894 An easy way to flash an image to a bootable device is to use
5895 <filename>bmaptool</filename>, which is integrated into the
5896 OpenEmbedded build system.
5897 </para>
5898
5899 <para>
5900 Following, is an example that shows how to flash a Wic image.
5901 <note>
5902 You can use <filename>bmaptool</filename> to flash any
5903 type of image.
5904 </note>
5905 Use these steps to flash an image using
5906 <filename>bmaptool</filename>:
5907 <note>
5908 Unless you are able to install the
5909 <filename>bmap-tools</filename> package as mentioned in the note
5910 in the second bullet of step 3 further down, you will need to build
5911 <filename>bmaptool</filename> before using it.
5912 Build the tool using the following command:
5913 <literallayout class='monospaced'>
5914 $ bitbake bmap-tools-native
5915 </literallayout>
5916 </note>
5917 <orderedlist>
5918 <listitem><para>
5919 <emphasis>Update the <filename>local.conf</filename> File:</emphasis>
5920 Add the following to your <filename>local.conf</filename>
5921 file:
5922 <literallayout class='monospaced'>
5923 IMAGE_FSTYPES += "wic wic.bmap"
5924 </literallayout>
5925 </para></listitem>
5926 <listitem><para>
5927 <emphasis>Get Your Image:</emphasis>
5928 Either have your image ready (pre-built) or take the step
5929 build the image:
5930 <literallayout class='monospaced'>
5931 $ bitbake <replaceable>image</replaceable>
5932 </literallayout>
5933 </para></listitem>
5934 <listitem><para>
5935 <emphasis>Flash the Device:</emphasis>
5936 Flash the device with the image by using
5937 <filename>bmaptool</filename> depending on your particular
5938 setup:
5939 <itemizedlist>
5940 <listitem><para>
5941 If you have write access to the media,
5942 use this command form:
5943 <literallayout class='monospaced'>
5944 $ oe-run-native bmaptool-native bmaptool copy ./tmp/deploy/images/qemux86-64-core-image-minimal-<replaceable>machine</replaceable>.wic /dev/sd<replaceable>X</replaceable>
5945 </literallayout>
5946 </para></listitem>
5947 <listitem><para>
5948 If you do not have write access to
5949 the media, use the following
5950 commands:
5951 <literallayout class='monospaced'>
5952 $ sudo bash
5953 $ 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>
5954 </literallayout>
5955 <note>
5956 If you are using Ubuntu or Debian distributions,
5957 you can install the
5958 <filename>bmap-tools</filename> package using
5959 the following command and then use the tool
5960 without specifying
5961 <filename>PATH</filename> even from the
5962 root account:
5963 <literallayout class='monospaced'>
5964 $ sudo apt-get install bmap-tools
5965 </literallayout>
5966 </note>
5967 </para></listitem>
5968 </itemizedlist>
5969 </para></listitem>
5970 </orderedlist>
5971 </para>
5972
5973 <para>
5974 For help on the <filename>bmaptool</filename> command, use the
5975 following command:
5976 <literallayout class='monospaced'>
5977 $ bmaptool --help
5978 </literallayout>
5979 </para>
5980 </section>
5981
5890 <section id='configuring-the-kernel'> 5982 <section id='configuring-the-kernel'>
5891 <title>Configuring the Kernel</title> 5983 <title>Configuring the Kernel</title>
5892 5984